Skip to main content

Authorization

shopify_api.png

Shopify

Shopify is an e-commerce platform that provides online store creation, product management, order processing, and customer relationship tools. The Shopify API allows you to integrate Shopify functionality into your applications, enabling automated store management, inventory tracking, and data synchronization.

Follow the instructions below to create a new Shopify credential in Nexla.

Prerequisites​

Before creating a Shopify credential, ensure you have the following:

Shopify Store Access​

You must have administrative privileges in a Shopify store to create apps and manage API access. This store provides access to the Shopify platform and its API capabilities.

Shopify App Creation​

You need to create a Shopify app in your store to obtain the required credentials for API access. Shopify apps provide API authentication and define the permissions your integration will have.

API Access Credentials​

The Shopify API uses API tokens for authentication. You will need to create a Shopify app and configure API access to obtain the required credentials.

  1. Create a Shopify App: Follow the instructions in the Shopify Developer Documentation to create a Shopify app in your store.

  2. Configure API Access: During app creation, ensure you configure the API access settings with appropriate scopes for your use case. Common scopes include:

    • Products: For reading and writing product information
    • Orders: For accessing order data and fulfillment
    • Customers: For customer management and data access
    • Inventory: For inventory tracking and management
    • Analytics: For store analytics and reporting

  3. Note your credentials: Once created, you will be provided with Store URL and API Token credentials. Keep these secure, as they are essential for authenticating your API requests.

For complete information about setting up Shopify apps and API access, refer to the official Shopify Developer Documentation.

Required Scopes​

Ensure your Shopify app is granted the necessary scopes to access the required Shopify functionality. The specific scopes needed depend on your use case:

  • Product Management: read_products, write_products for product operations
  • Order Management: read_orders, write_orders for order processing
  • Customer Access: read_customers, write_customers for customer management
  • Inventory Management: read_inventory, write_inventory for inventory operations
  • Analytics: read_analytics for store analytics and reporting

App Installation​

The Shopify app must be installed in your store to generate API tokens. During installation, you will be prompted to authorize the requested permissions.

Authentication Method​

Shopify uses API token authentication, which provides secure, app-based access to Shopify APIs with proper permission management.

API Token Configuration​

  1. Shopify Store URL: Enter the URL of your Shopify store without the protocol (https://). This should be in the format your-store-name.myshopify.com. This URL identifies your specific Shopify store instance.

  2. Custom App Access Token: Enter the Admin API Access Token for your Shopify Custom App. This token authenticates your application with Shopify's API and should be kept secure.

The API token is used to authenticate all API requests to your Shopify store. Ensure this token is kept secure and never exposed in client-side code or public repositories.

Security Considerations​

  • Credential Protection: Keep your API token secure and never expose it in client-side code or public repositories.
  • Scope Limitation: Only request the minimum scopes necessary for your application's functionality to follow the principle of least privilege.
  • Token Management: API tokens are managed by Shopify and do not require refresh operations.
  • Store Access: Ensure your Shopify store has the necessary permissions to perform the operations your application requires.

API Rate Limits​

The Shopify API enforces rate limiting to ensure optimal performance and fair usage across all users.

  • Rate Limits: Vary by endpoint and store plan
  • Exceeding Limits: Requests exceeding limits will receive appropriate HTTP status codes
  • Best Practice: Implement appropriate retry logic and respect rate limits in your application design

For detailed information about Shopify API rate limits and best practices, see the Shopify API Rate Limiting Documentation.

Next Steps​

Once you have created your Shopify credential, you can:

For additional information about Shopify API capabilities and use cases, refer to the Shopify Developer Documentation.