How to Add an eCommerce Integration in ShipBoss Admin

Contents

• Shopify Integration
• Magento Integration
• Troubleshooting and Support

To integrate your eCommerce platforms such as Shopify or Magento with ShipBoss through the admin interface, follow the respective steps outlined below.

Shopify Integration

Step 1: Create an API Key in Shopify

1. Navigate to App Development:

• Log into your Shopify admin account.
• Go to the App development section.
• Click on Develop apps.

2. Create an App:

• Click on Create an app.
• Provide a name for your app and proceed to create it.

Step 2: Configure API Access

You need to configure the app with the necessary API scopes to allow ShipBoss to interact with Shopify.

1. Set the API Scopes:

• Ensure that your app has the following scopes:
• • write_assigned_fulfillment_orders
  • read_assigned_fulfillment_orders
  • write_fulfillments
  • read_fulfillments
  • write_inventory
  • read_inventory
  • write_orders
  • read_orders
  • read_channels
  • write_channels
  • write_shipping
  • read_shipping
  • write_merchant_managed_fulfillment_orders
  • read_merchant_managed_fulfillment_orders
  • write_third_party_fulfillment_orders
  • read_third_party_fulfillment_orders
  • write_custom_fulfillment_services
  • read_custom_fulfillment_services

Step 3: Generate the Admin API Access Token

1. Generate the Token:

• After configuring the required scopes, generate your Admin API access token.
• Important: This token will only be visible once, so save it securely.

Step 4: Complete the Integration in ShipBoss

1. Log into ShipBoss:

• Access the ShipBoss admin portal.
• Navigate to the Admin section.

2. Insert the API Token:

• In the appropriate field, paste the Shopify API token you generated.
• Save the integration settings.

3. Finalize the Integration:

• Ensure that all settings are correctly configured to avoid errors.
• Once saved, the integration should be active, allowing ShipBoss to interact with your Shopify store.

Magento Integration

Instructions for Setting Up a Third-Party Integration with Magento Using URL, Username, and Password

Step 1: Ensure You Have Admin Credentials

Verify that you have access to an existing admin account on your Magento store. You will need the following:

• URL: The base URL of your Magento store's API.
• Username: The username of the admin account.
• Password: The password associated with the admin account.

Step 2: Determine the API URL

• Base URL of Your Magento Store: This is the main URL you use to access your store (e.g., https://yourstore.com).
• Magento REST API Endpoint: The standard API endpoint for REST is https://yourstore.com/rest/V1/.
• Magento SOAP API Endpoint (if applicable): The standard SOAP API endpoint is https://yourstore.com/soap/default?wsdl&services=all.

Step 3: Assign or Verify Permissions

Ensure that the admin user account has the necessary permissions to access the resources required by ShipBoss.

• You can adjust permissions under System > Permissions > User Roles in the Magento Admin Panel if needed.

Step 4: Provide the Credentials to ShipBoss

Supply the following information to ShipBoss for the integration:

• API URL: The base API URL you determined earlier.
• Username: The admin account's username.
• Password: The corresponding password.

Example

If your Magento store's URL is https://example.com:

• REST API Base URL: https://example.com/rest/V1/
• SOAP API Base URL: https://example.com/soap/default?wsdl&services=all

You would provide these URLs, along with the admin username and password, to ShipBoss to complete the integration.

Troubleshooting and Support

• Shopify: If you encounter issues during the Shopify integration process, verify that the API scopes are set correctly and the API token is accurately copied.
• Magento: Ensure that the Magento API URL, username, and password are correct and that the admin account has the necessary permissions.

Updated on: 11/11/2024