Customers

Magento Customers API

Sync permissioned customers data with Magento through Apideck's unified API. One integration, instant access to the governed data your team needs.

Supported Operations for Magento Customers

List, Get operations available through our unified API

list

get

create

update

delete

Supported Fields

12 fields

Fields available for Magento Customers

idnamefirst_namelast_namecompany_namestatusemailsphone_numbersaddressesorderscreated_atupdated_at

API Model Preview

Sample response structure for customers

{
  "id": "12345",
  "name": "Example Name",
  "first_name": "Example First Name",
  "last_name": "Example Last Name",
  "company_name": "Example Company Name",
  "status": "active",
  "emails": [
    {
      "id": "12345",
      "email": "contact@example.com",
      "type": "primary"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "number": "+1-555-123-4567",
      "type": "primary"
    }
  ],
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "2
  ...

Quick Start Example

Start syncing Magento customers in minutes

Node.js

import { Apideck } from '@apideck/unify'

const apideck = new Apideck({
  apiKey: process.env.APIDECK_API_KEY,
  appId: 'YOUR_APP_ID',
  consumerId: 'YOUR_CONSUMER_ID'
})

// List customers from Magento
const result = await apideck.ecommerce.customers.list({
  serviceId: 'magento'
})

for await (const page of result) {
  console.log(page)
}
// Returns unified customers data

View full SDK documentation

Popular Use Cases

How Customers is Commonly Used

Discover the most popular ways businesses integrate Magento customers data

Accounts Receivable

Push invoices, payment statuses & credits into users' ledgers.

Learn more

Explore all use cases

Other connectors with Customers support

We build and maintain connectors, so you don't have to. View our full list of Ecommerce connectors.
Missing a connector? We're able to add new connectors.