Merchants

get_merchants

Get list of merchants for the authenticated user's organization

get_merchants

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_merchants",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "where": {
          "isActive": true,
          "isArchived": true
        }
      }
  }
}

const result = await client.callTool({
  "name": "get_merchants",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "where": {
      "isActive": true,
      "isArchived": true
    }
  }
});

result = await session.call_tool("get_merchants", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "where": {
    "isActive": true,
    "isArchived": true
  }
})

Request Body

{
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "where": {
    "isActive": true,
    "isArchived": true
  }
}

Body

application/json

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for merchant name, code, or email

relationsArray<string>

Relations to include (e.g., ["contact", "tags"])

whereobject

Additional filters

Show child attributes

isActiveboolean

isArchivedboolean

get_merchant_count

Get merchant count in the authenticated user's organization

get_merchant_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_merchant_count",
    "arguments": {
        "where": {
          "isActive": true,
          "isArchived": true
        }
      }
  }
}

const result = await client.callTool({
  "name": "get_merchant_count",
  "arguments": {
    "where": {
      "isActive": true,
      "isArchived": true
    }
  }
});

result = await session.call_tool("get_merchant_count", arguments={
  "where": {
    "isActive": true,
    "isArchived": true
  }
})

Request Body

{
  "where": {
    "isActive": true,
    "isArchived": true
  }
}

Body

application/json

whereobject

Additional filters

Show child attributes

isActiveboolean

isArchivedboolean

get_merchant

Get a specific merchant by ID

get_merchant

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_merchant",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_merchant",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_merchant", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The merchant ID

relationsArray<string>

Relations to include (e.g., ["contact", "tags"])

create_merchant

Create a new merchant in the authenticated user's organization

create_merchant

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_merchant",
    "arguments": {
        "merchant_data": {
          "name": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_merchant",
  "arguments": {
    "merchant_data": {
      "name": "string"
    }
  }
});

result = await session.call_tool("create_merchant", arguments={
  "merchant_data": {
    "name": "string"
  }
})

Request Body

{
  "merchant_data": {
    "name": "string"
  }
}

Body

application/json

merchant_dataobjectrequired

The data for creating the merchant

Show child attributes

namestringrequired

The name (required)

[key: string]any

update_merchant

Update an existing merchant

update_merchant

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_merchant",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "merchant_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_merchant",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "merchant_data": {}
  }
});

result = await session.call_tool("update_merchant", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "merchant_data": {}
})

Parameters

idstring<uuid>required

The merchant ID

merchant_dataobjectrequired

The data for updating the merchant

delete_merchant

Delete a merchant

delete_merchant

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_merchant",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_merchant",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_merchant", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The merchant ID

archive_merchant

Archive a merchant (soft delete)

archive_merchant

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "archive_merchant",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "archive_merchant",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("archive_merchant", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The merchant ID

restore_merchant

Restore an archived merchant

restore_merchant

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "restore_merchant",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "restore_merchant",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("restore_merchant", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The merchant ID

get_merchant_by_code

Get a merchant by its unique code

get_merchant_by_code

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_merchant_by_code",
    "arguments": {
        "code": "string",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_merchant_by_code",
  "arguments": {
    "code": "string",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_merchant_by_code", arguments={
  "code": "string",
  "relations": [
    "string"
  ]
})

Parameters

codestringrequired

The merchant code

relationsArray<string>

Relations to include

search_merchants

Search merchants by name, code, email, or description

search_merchants

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_merchants",
    "arguments": {
        "query": "string",
        "limit": 20,
        "includeArchived": false
      }
  }
}

const result = await client.callTool({
  "name": "search_merchants",
  "arguments": {
    "query": "string",
    "limit": 20,
    "includeArchived": false
  }
});

result = await session.call_tool("search_merchants", arguments={
  "query": "string",
  "limit": 20,
  "includeArchived": false
})

Parameters

querystringrequired

Search query

limitnumber20

Maximum number of results

includeArchivedbooleanfalse

Include archived merchants in search

get_merchant_statistics

Get merchant statistics for the authenticated user's organization

get_merchant_statistics

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_merchant_statistics",
    "arguments": {
        "startDate": "string",
        "endDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_merchant_statistics",
  "arguments": {
    "startDate": "string",
    "endDate": "string"
  }
});

result = await session.call_tool("get_merchant_statistics", arguments={
  "startDate": "string",
  "endDate": "string"
})

Parameters

startDatestring

Start date for statistics (ISO format)

endDatestring

End date for statistics (ISO format)

bulk_create_merchants

Create multiple merchants in bulk for the authenticated user's organization

bulk_create_merchants

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "bulk_create_merchants",
    "arguments": {
        "merchants": [
          {
            "name": "string"
          }
        ]
      }
  }
}

const result = await client.callTool({
  "name": "bulk_create_merchants",
  "arguments": {
    "merchants": [
      {
        "name": "string"
      }
    ]
  }
});

result = await session.call_tool("bulk_create_merchants", arguments={
  "merchants": [
    {
      "name": "string"
    }
  ]
})

Request Body

{
  "merchants": [
    {
      "name": "string"
    }
  ]
}

Body

application/json

merchantsArray<object>required

Array of merchant data to create

Show child attributes

Merchant data

namestringrequired

The name (required)

[key: string]any

get_active_merchants

Get only active (non-archived) merchants for the authenticated user's organization

get_active_merchants

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_active_merchants",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_active_merchants",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_active_merchants", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ]
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for merchant name, code, or email

relationsArray<string>

Relations to include

get_archived_merchants

Get archived merchants for the authenticated user's organization

get_archived_merchants

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_archived_merchants",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_archived_merchants",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_archived_merchants", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ]
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for merchant name, code, or email

relationsArray<string>

Relations to include

Stack Overflow Website Demo