Buildadocs
⌘K
GuidesAPI ReferenceIntegrationsChangelog

Magento Requirements

| Requirement | Details | |-------------|---------| | **Admin access** | You need admin-level access to create API integrations | | **API enabled** | Magento REST API must be accessible from the internet | | **Integration permissions** | The API integration must have the correct

Magento Requirements

Supported Versions

  • Magento 2.x (Open Source or Commerce)
  • Magento 1.x is not supported

Required Magento Configuration

RequirementDetails
Admin accessYou need admin-level access to create API integrations
API enabledMagento REST API must be accessible from the internet
Integration permissionsThe API integration must have the correct resource scopes

Required API Resource Scopes

When creating the Magento integration, grant access to:

  • Catalog — Product data, categories, pricing
  • Sales — Order and cart operations
  • Stores — Store views and configurations

The exact permissions needed depend on your Magento setup. Grant the minimum required for your use case.

Network Requirements

  • Builda's servers must be able to reach your Magento API endpoint
  • If your Magento instance is behind a firewall, you may need to whitelist Builda's IP addresses (contact support for the current list)
  • HTTPS is required — Builda will not connect over plain HTTP