Merchants

Clover Merchants API

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

Supported Operations for Clover Merchants

List, Get, Update operations available through our unified API

list

get

create

update

delete

Supported Fields

6 fields

Fields available for Clover Merchants

idnameaddressowner_idservice_chargescreated_at

API Model Preview

Sample response structure for merchants

{
  "id": "12345",
  "name": "Example Name",
  "address": {
    "id": "123",
    "type": "primary",
    "string": "25 Spring Street, Blackburn, VIC 3130",
    "name": "HQ US",
    "line1": "25 Spring Street",
    "line2": "Suite 100",
    "city": "Blackburn",
    "state": "VIC",
    "postal_code": "3130",
    "country": "US"
  },
  "owner_id": "12345",
  "service_charges": "string",
  "created_at": "2024-01-15T10:30:00.000Z"
}

Quick Start Example

Start syncing Clover merchants 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 merchants from Clover
const result = await apideck.pos.merchants.list({
  serviceId: 'clover'
})

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

View full SDK documentation