{ } API Explorer Support

OpenCart

Avasam can be integrated with one or more OpenCart websites to download orders, and update listings with stock levels. sales channel integrations

The list of sales channel integrations has 4 columns:

  • The logo representing the type of channel integration.
  • The type of channel integration.
  • The name of the specific channel integration.
  • The status of the integration - yes/blue is enabled, no/grey is disabled.

New sales channel integration

To create new sales channel integration:

  1. Open ‘Settings’.
  2. Select ‘Sales channel integration’.
  3. Click the ‘Add sales channel’ button.
  4. Click on the ‘Add’ button next to ‘OpenCart’. Click on Add button for OpenCart
  5. Enter the name for this integration. Enter account name
  6. Click ‘Next’ to continue. Configuration screen
  7. Enter your website address in the ‘OpenCart end point’ field.
  8. The ‘Key’field comes from your website.
    a. Login to the control panel of your website.
    Login to control panel b. Select the ‘Settings’ menu, by clicking on the ‘gear’ icon to the right.
    Select settings menu c. Select the ‘Users’ menu, and the ‘API’ option.
    Select Users and API d. In the ‘APIs’ screen, click the ‘+’ button to the top right.
    API screen and + button, e. Make sure you are in the ‘General’ tab.
    General tab. f. Enter ‘Avasam’ as the name for this entry.
    g. Click ‘Generate’.
    API key value h. This will provide you with an ‘API key’ value. Copy this value.
    i. Click the ‘Save’ button (Floppy disk symbol) to return to the ‘APIs’ screen.
    Click Edit j. Click ‘Edit’ for the new entry (Pencil symbol).
    k. Select the ‘IP Addresses’ tab.
    IP addresses tab l. Click the ‘+’ button.
    m. Enter the value ’54.152.197.155’ in the ‘IP’ field.
    n. Click ‘Save’ (Floppy disk symbol) to return to the ‘APIs’ screen.
  9. Paste this value into the ‘Key’ field. Paste value into Key field
  10. Set the correct ‘Currency’ for your site.
  11. Select ‘True’ or ‘False’ to match whether you want to use the Tax settings in OpenCart for your listing prices (‘Use OpenCart tax settings’).
  12. In ‘Tax type’, set True if your prices are inclusive of VAT. Otherwise, select ‘False’.
  13. Click ‘Next’ to continue.
  14. The next screen requires additional settings to be specified. Select ‘Yes’ for fields where you are using that option in OpenCart. additional settings a. For ‘Processed order status’, specify the status Avasam should assign to orders when it has been shipped by the supplier.
  15. Click ‘Next’.
  16. You will be returned to the sales channel list in Avasam, with a new row added for your new integration. sales channel list
  • Click ‘Cancel’ to return to the sales channel integration list without completing the integration.

Disable channel integration

When you create new channel integration, it is automatically enabled and active.

To disable the integration to stop it downloading orders and updating listings temporarily:

  1. Open ‘Settings’.
  2. Select ‘Sales channel integration’.
  3. Locate the integrated sales channel to disable.
  4. Click the status switch to toggle it from ‘Yes’/active to ‘No’/disabled.
  5. The channel will be disabled.

Enable channel integration

When you create new channel integration, it is automatically enabled and active. You, or someone else, may temporarily disable it.

To re-enable the integration to resume downloading orders and updating listings:

  1. Open ‘Settings’.
  2. Select ‘Sales channel integration’.
  3. Locate the integrated sales channel to enable.
  4. Click the status switch to toggle it from ‘No’/disabled to ‘Yes’/active.
  5. The channel will be re-enabled.

Remove channel integration

If you no longer wish to have Avasam connected to a sales channel, it can be easily removed. Once deleted, you will need to re-create the integration from scratch should you choose to re-use it.

To remove channel integration:

  1. Open ‘Settings’.
  2. Select ‘Sales channel integration’.
  3. Locate the channel integration to remove.
  4. Click the name to open the integration. Remove channel integration
  5. Click the red ‘Remove account’ button.
  6. Click ‘OK’ to confirm.
  7. You will be returned to the list of channel integrations.
  • Click ‘Cancel’ if you decide to not delete the integration.
  • If you delete integration and then reintegrate the same channel, the analytics and reports will not recognise orders from the two integrations as being from the same site.

Update/verify channel integration

If Avasam is having issues downloading from updating a sales channel, it can be easily checked. In ‘Settings’, select ‘Sales channel integration’ to ensure that you are connecting to the correct website end point.

To update/verify a channel integration:

  1. Locate the channel integration.
  2. Click the name to open the integration. Update-verify channel integration
  3. Click ‘Reauthorise’. Reauthorise
  4. Check the ‘OpenCart end point’ value is correct.
  5. Confirm the ‘Key’ is correct.
  6. Click ‘Save’ to apply any updates/changes.
  7. You will be returned to the list of channel integrations.
  • Click ‘Cancel’ if you decide to not change/update the integration.

Shipping mapping

If you want the shipping service paid for by the customer to automatically select the correct shipping provider and service when the order is downloaded to Avasam, then you will need to map the services from the site/channel to those in Avasam. Shipping mapping The ‘Shipping mapping’ section will list any existing mappings. You can open/expand the ‘marketplace to Avasam’ shipping mapping section by clicking on the arrow to the right of the title.

If any services are already mapped, then they will be listed here.

Delete a shipping mapping

To delete a shipping mapping:

  1. Locate the service.
  2. Click the ‘X’ to the right of the service.
  3. Click ‘Save’ to apply the change.

Create a new shipping mapping

To create a new shipping mapping

  1. Select the service to map under the ‘Sales channel shipping service’ drop down list.
  2. Select the Avasam shipping service to map this against under the ‘Avasam shipping service’ drop down list.
  3. Click ‘Map field’.
  • This will only affect orders downloaded after it is mapped. It will not affect orders already in Avasam.

SKU mapping

If you want Avasam to automatically recognise the correct Avasam Inventory SKU when the order is downloaded to Avasam, then you will need to ensure they are mapped correctly from the site to those in Avasam. SKU mapping The ‘SKU mapping’ section will list all existing mappings. You can open/expand the ‘SKU mapping’ section by clicking on the arrow to the right of the title.

Create a new SKU mapping

To create a new SKU mapping:

  1. Select the SKU to map under the ‘Sales channel shipping service’ drop down list.
  2. Select the Avasam SKU to map this against under the ‘Avasam SKU’ drop list.
  3. Click ‘Map them’. Create new SKU mapping
  • Changes made will only affect orders downloaded after it is mapped. It will not affect orders already in Avasam.
  • The ‘Save button will apply any changes you have made to the mappings.
  • You can return to the main page at any time without applying the changes by clicking on the ‘Sales channel integrations’ link on the top left, or the ‘Cancel’ button.