Sign Customiser

Navigation

Dark mode

Find a sign manufacturer in the Find Sign Makers directory, and obtain the manufacturer id get_manufacturer takes.

Overview

Lists the sign manufacturers of the Find Sign Makers directory, the same directory for every Store, in the order they were added: each manufacturer id, name, short description, location, the sign types it makes, its specialties, and whether it is verified and Pro. A search filter keeps the manufacturers whose name, profile slug or location contains a term of 2 to 100 characters. Contact details and the full profile are a get_manufacturer read. 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

limitinteger

How many manufacturers to return per page, between 1 and 100. Defaults to 20.

cursorstring

The opaque next_cursor value from the previous page, sent back with the identical filter.

filterobject

Optional filters. An unknown filter is rejected, never ignored.

filter.searchstring

Only manufacturers whose name, profile slug or location contains this term, with the same case. It is trimmed and must then have 2 to 100 characters.

Result

Up to `limit` manufacturer summaries, oldest first, plus the cursor for the next page.

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

The page of manufacturers, oldest first.

manufacturers[].idintegeralways present
manufacturers[].namestringalways present
manufacturers[].slugstring or null
manufacturers[].short_descriptionstring or null
manufacturers[].locationstring or null
manufacturers[].citystring or null
manufacturers[].regionstring or null
manufacturers[].countrystring or null
manufacturers[].product_typearray of string

The sign types it makes.

manufacturers[].specialtiesarray of string

Its specialties.

manufacturers[].is_verifiedbooleanalways present
manufacturers[].is_publicly_verifiedbooleanalways present
manufacturers[].is_probooleanalways present
paginationobjectalways present
pagination.has_morebooleanalways present
pagination.next_cursorstring or null

Error cases

insufficient_scope

The connection was approved without store:read.

invalid_cursor

The cursor was altered or reused with a different search; restart with no cursor.

invalid_parameter

The search term has fewer than 2 or more than 100 characters after it is trimmed, or limit is not an integer from 1 to 100.

unknown_filter

Remove the filter named in parameter. This tool forwards unknown filter names so the API can refuse them explicitly.

Manufacturers matching a name

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_manufacturers",
    "arguments": {
      "limit": 1,
      "filter": {
        "search": "Bright"
      }
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "manufacturers": [
        {
          "id": 318,
          "name": "Bright Signs Co",
          "slug": "bright-signs-co",
          "short_description": "LED neon and channel letters.",
          "location": "Brisbane, Australia",
          "city": "Brisbane",
          "region": "Queensland",
          "country": "AU",
          "product_type": [
            "neon",
            "channel_letters"
          ],
          "specialties": [
            "Custom logos"
          ],
          "is_verified": true,
          "is_publicly_verified": true,
          "is_pro": false
        }
      ],
      "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": "list_manufacturers",
    "arguments": {
      "filter": {
        "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.