SyncNship Integration Guide

How to Add an eCommerce Integration in WebShip Admin

Integrate your eCommerce platforms such as Shopify or Magento with WebShip through the admin interface.

Part 1 — Shopify

Create an API Key in Shopify

1

Navigate to App Development

2

Create an App

Part 2 — Shopify

Configure API Access

3

Set the API Scopes

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

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
Part 3 — Shopify

Generate the Admin API Access Token

4

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.
Part 4 — Shopify

Complete the Shopify Integration in WebShip

5

Log into WebShip

6

Insert the API Token

In the appropriate field, paste the Shopify API token you generated.

Save the integration settings.

7

Finalize the Shopify Integration

Part 5 — Magento

Ensure You Have Admin Credentials

8

Verify Admin Account Access

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

Part 6 — Magento

Determine the API URL & Verify Permissions

9

Identify Your API Endpoints

Base URL of Your Magento Store: This is the main URL you use to access your store (e.g., https://yourstore.com).

Endpoint TypeURL Format
REST APIhttps://yourstore.com/rest/V1/
SOAP APIhttps://yourstore.com/soap/default?wsdl&services=all
10

Assign or Verify Permissions

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

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

Part 7 — Magento

Provide the Credentials to WebShip

11

Supply Integration Information

Supply the following information to WebShip for the integration:

FieldWhat to Enter
API URLThe base API URL you determined earlier
UsernameThe admin account's username
PasswordThe corresponding password
12

Example Configuration

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

EndpointURL
REST API Base URLhttps://example.com/rest/V1/
SOAP API Base URLhttps://example.com/soap/default?wsdl&services=all

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

Part 8

Troubleshooting and Support

13

Shopify Troubleshooting

If you encounter issues during the Shopify integration process, verify that the API scopes are set correctly and the API token is accurately copied.

14

Magento Troubleshooting

Ensure that the Magento API URL, username, and password are correct and that the admin account has the necessary permissions.

eCommerce Integration Complete!

Your Shopify and/or Magento store is now connected to WebShip via SyncNship. Orders and fulfillment data will sync automatically.