Search sub-merchants

GEThttps://api.omise.co/sub_merchants/search

Search and filter sub-merchants to find merchants by name, email, business details, metadata, and more. The Search API provides powerful full-text search capabilities across all sub-merchants in your platform.

---

Request Parameters

Recommended - 2 fieldsRecommended Parameters

▼

`query`STRING(optional)

Search query string. Searches across sub-merchant name, email, business name, description, and metadata. Supports multiple words (AND logic) and partial matches.

Example:"acme electronics"

`filters`OBJECT(optional)

Filter criteria to narrow search results. Common filters include status, type, business_category, and created date ranges.

Example:{"status":"active","type":"business"}

Pagination - 3 fieldsPagination Parameters

▼

---

Responses

200

Successful search

Search completed successfully. Returns a search result object with matching sub-merchants in the data array.

Response includes:

• object - Always "search"
• data - Array of sub-merchant objects matching the search criteria
• total - Total number of results matching the search
• total_pages - Number of pages available
• page - Current page number
• per_page - Number of results per page
• order - Sort order applied (chronological or reverse_chronological)

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid page number (below 1)
• Invalid per_page value (above 100 or below 1)
• Malformed filters object
• Invalid filter field name

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

Platform account not found or sub-merchant feature not enabled.

Common causes:

• Account is not a platform account
• Sub-merchant feature not enabled
• Contact support to enable platform features

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=acme electronics" \
  -d "filters[status]=active" \
  -d "filters[type]=business"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::SubMerchant.search({
  query: 'acme electronics',
  filters: {
    status: 'active',
    type: 'business'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.SubMerchant.search(
    query='acme electronics',
    filters={
        'status': 'active',
        'type': 'business'
    }
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const results = await omise.subMerchants.search({
  query: 'acme electronics',
  filters: {
    status: 'active',
    type: 'business'
  }
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$results = OmiseSubMerchant::search([
    'query' => 'acme electronics',
    'filters' => [
        'status' => 'active',
        'type' => 'business'
    ]
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Map<String, Object> filters = new HashMap<>();
filters.put("status", "active");
filters.put("type", "business");

SearchResult<SubMerchant> results = client.subMerchants()
    .search()
    .query("acme electronics")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.SubMerchants.Search(new SearchRequest
{
    Query = "acme electronics",
    Filters = new Dictionary<string, object>
    {
        { "status", "active" },
        { "type", "business" }
    }
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

results, _ := client.SubMerchants().Search(&operations.SearchSubMerchants{
    Query: "acme electronics",
    Filters: map[string]interface{}{
        "status": "active",
        "type":   "business",
    },
})

---

Search examples

Search by name or email

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=john@example.com"

Search with status filter

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "filters[status]=pending"

Search by business category

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "filters[business_category]=electronics_retail"

Search by date range

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "filters[created][gte]=2025-01-01" \
  -d "filters[created][lte]=2025-03-31"

Combined search with multiple filters

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=premium" \
  -d "filters[status]=active" \
  -d "filters[type]=business" \
  -d "filters[business_category]=electronics_retail" \
  -d "per_page=50"

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Missing or invalid parameters	Check that parameters are valid
authentication_failure	Invalid API key	Verify your secret key is correct
platform_not_enabled	Platform features not enabled	Contact support to enable platform account

Search Filter Options

Filter	Type	Description
status	string	Sub-merchant status (pending, active, suspended, deactivated, rejected)
type	string	Sub-merchant type (individual, business)
business_category	string	Business category code
created	object	Date range filter (e.g., {gte: '2025-01-01', lte: '2025-01-31'})

Searchable Fields

The search query matches against the following fields:

• name - Sub-merchant display name
• email - Contact email
• business_name - Registered business name
• description - Internal description
• metadata - Custom metadata values

---

🔑API Credentials

▼

Try it out

Recommended - 2 fields

▼

Additional - 3 fields

▼

Your IP: ...Loading...