Sign Customiser

Navigation

Dark mode

Store

search_manufacturer_link_listings

read

Search manufacturer link listings

Copy page

Find the listing a merchant wants to link, so they can ask for the link in the merchant admin.

Overview

Finds the Find Sign Makers listings the connected Store could ask to link, as the merchant admin link picker does: only listings a manufacturer account claimed, whose name, profile slug or location contains the search term (2 to 100 characters after trimming). It returns at most 10 listings in name order, each with its manufacturer id, name, location, whether another Store holds it and whether it is publicly verified; send a longer term to find a listing that is not shown. It cannot ask for a link. Each connection can search 30 times a minute. It requires the store:read scope and has no side effects.

Permission

Requires thestore:readpermission. A connection without it answersinsufficient_scopenaming the permission to approve.

Annotations

readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
openWorldHintfalse

Prerequisites

  • A merchant has connected this store and approved the store:read scope.

Arguments

searchstringrequired

The term the listing name, profile slug or location must contain, with the same case. It is trimmed and must then have 2 to 100 characters.

Result

At most 10 matching listings in name order, in one page.

request_idstringalways present
storeobjectalways present
store.idintegeralways present
store.namestringalways present
listingsarray of objectalways present

At most 10 listings, in name order.

listings[].manufacturer_idintegeralways present
listings[].namestringalways present
listings[].locationstring or null
listings[].is_linkedbooleanalways present

True when another Store holds the listing.

listings[].is_publicly_verifiedbooleanalways present
paginationobjectalways present
pagination.has_morebooleanalways present
pagination.next_cursorstring or null

Error cases

insufficient_scope

The connection was approved without store:read.

invalid_parameter

The search term has fewer than 2 or more than 100 characters after it is trimmed.

rate_limited

This connection has searched 30 times in the last minute. Wait retry_after seconds.

Listings matching a name

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_manufacturer_link_listings",
    "arguments": {
      "search": "Bright"
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "listings": [
        {
          "manufacturer_id": 318,
          "name": "Bright Signs Co",
          "location": "Brisbane, Australia",
          "is_linked": false,
          "is_publicly_verified": true
        }
      ],
      "pagination": {
        "has_more": false,
        "next_cursor": null
      }
    }
  }
}

A search term that is too short (error)

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_manufacturer_link_listings",
    "arguments": {
      "search": "B"
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "invalid_parameter",
        "title": "Invalid query parameter",
        "detail": "The filter[search] term must have 2 to 100 characters after it is trimmed.",
        "parameter": "filter[search]",
        "recovery": "Correct the parameter named in parameter. Dates are YYYY-MM-DD in UTC and identifiers are integers between 1 and 2147483647."
      }
    }
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.