Skip to main content

Authorization

Follow this guide to create a new Shopify credential that will allow Nexla to authenticate to and exchange data with your Shopify account.
shopify_api.png

Shopify

Prerequisites​

Before creating a Shopify credential, you need to obtain your Shopify Store URL and Custom App Access Token from your Shopify account. Shopify uses API token authentication for all API requests, with the token sent in the X-Shopify-Access-Token header.

To obtain your Shopify credentials, follow these steps:

  1. Sign in to your Shopify admin account using your administrator credentials.

  2. Navigate to Settings in your Shopify admin by clicking the gear icon in the bottom left corner of the admin interface.

  3. In the Settings menu, click Apps and sales channels or navigate to Settings > Apps and sales channels.

  4. Click Develop apps to access the app development section. If you don't see this option, you may need to enable developer mode or have the appropriate permissions.

  5. Click Create an app to create a new custom app for API access.

  6. Enter a name for your app (e.g., "Nexla Integration") and an optional developer email, then click Create app.

  7. After the app is created, click Configure Admin API scopes to set up the permissions your app will need. Select the scopes required for your use case:

    • Products: read_products, write_products for product operations
    • Orders: read_orders, write_orders for order processing
    • Customers: read_customers, write_customers for customer management
    • Inventory: read_inventory, write_inventory for inventory operations
    • Analytics: read_analytics for store analytics and reporting

  8. Click Save to save the API scopes configuration.

  9. Click API credentials in the app configuration page to view your API credentials.

  10. Under Admin API access token, click Install app if the app hasn't been installed yet, or click Reveal token once to view your access token.

  11. Copy the Admin API access token immediately after it's revealed, as it may not be accessible again after you navigate away from the page.

  12. Your Shopify Store URL is your store's domain name without the protocol (e.g., your-store-name.myshopify.com). You can find this in your Shopify admin URL or in the store settings.

  13. Store both credentials securely, as you will need them to configure your Nexla credential. The Admin API access token is sensitive information and should be kept confidential.

The Admin API access token is sent in the X-Shopify-Access-Token header for all API requests to the Shopify API. The Store URL is used to construct the API endpoint URL (e.g., https://{storeUrl}/admin/api/{version}/orders.json). The token authenticates your requests and grants access to Shopify resources based on the scopes you configured for your app. If your access token is compromised, you should immediately revoke it in your Shopify app settings and generate a new one. For detailed information about creating Shopify apps, API authentication, and available endpoints, refer to the Shopify Developer Documentation.

Create a Shopify Credential​

  • To create a new Shopify credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Shopify

ShopifyCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Token Authentication​

Shopify uses API token authentication for all API requests. The Custom App Access Token is sent in the X-Shopify-Access-Token header, and the Store URL is used to construct the API endpoint URL.

  1. Enter your Shopify Store URL in the Shopify Store URL (ex: nexla-store.myshopify.com) field. This should be your Shopify store domain name without the protocol (e.g., nexla-store.myshopify.com). If you access your Shopify store at https://example.myshopify.com, then the store URL is example.myshopify.com. The Store URL is used to construct the API endpoint URL for your Shopify store.

  2. Enter your Custom App Access Token in the Custom App Access token field. This is the Admin API Access Token for your Shopify Custom App that you obtained from your Shopify admin (Settings > Apps and sales channels > Develop apps > [Your App] > API credentials). The Admin API Access Token is sent in the X-Shopify-Access-Token header for all API requests to the Shopify API. The Admin API access token is sensitive information and must be kept confidential.

    Your Shopify credentials can be found in your Shopify admin under Settings > Apps and sales channels > Develop apps > [Your App] > API credentials. The Admin API Access Token is sent in the X-Shopify-Access-Token header for all API requests to the Shopify API.

    If your Admin API access token is compromised, you should immediately revoke it in your Shopify app settings and generate a new one. The Admin API access token provides access to your Shopify store data and should be treated as sensitive information. Keep your access token secure and do not share it publicly.

    For detailed information about creating Shopify apps, API authentication, API scopes, and available endpoints, see the Shopify Developer Documentation and Shopify Admin API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.