fyi.atstore.directory.getListing

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "listingCardGet": {
      "nullable": [
        "iconUrl",
        "heroImageUrl",
        "categorySlug",
        "rating",
        "productAccountHandle"
      ],
      "properties": {
        "accent": {
          "knownValues": [
            "blue",
            "pink",
            "purple",
            "green"
          ],
          "maxLength": 16,
          "type": "string"
        },
        "appTags": {
          "items": {
            "maxLength": 256,
            "type": "string"
          },
          "type": "array"
        },
        "category": {
          "maxLength": 640,
          "type": "string"
        },
        "categorySlug": {
          "maxLength": 512,
          "type": "string"
        },
        "categorySlugs": {
          "items": {
            "maxLength": 512,
            "type": "string"
          },
          "type": "array"
        },
        "description": {
          "maxLength": 20000,
          "type": "string"
        },
        "heroImageUrl": {
          "maxLength": 8192,
          "type": "string"
        },
        "iconUrl": {
          "maxLength": 8192,
          "type": "string"
        },
        "name": {
          "maxLength": 640,
          "type": "string"
        },
        "priceLabel": {
          "maxLength": 32,
          "type": "string"
        },
        "productAccountHandle": {
          "maxLength": 512,
          "type": "string"
        },
        "rating": {
          "maxLength": 16,
          "type": "string"
        },
        "reviewCount": {
          "type": "integer"
        },
        "tagline": {
          "maxLength": 2000,
          "type": "string"
        },
        "uri": {
          "description": "AT URI of the fyi.atstore.listing.detail record.",
          "format": "at-uri",
          "maxLength": 2560,
          "type": "string"
        }
      },
      "required": [
        "uri",
        "name",
        "tagline",
        "description",
        "category",
        "accent",
        "reviewCount",
        "priceLabel",
        "appTags",
        "categorySlugs",
        "iconUrl",
        "heroImageUrl",
        "categorySlug",
        "rating",
        "productAccountHandle"
      ],
      "type": "object"
    },
    "listingDetailResponse": {
      "nullable": [
        "repoDid",
        "productAccountDid",
        "sourceTagline",
        "sourceFullDescription",
        "externalUrl",
        "sourceUrl",
        "createdAt",
        "updatedAt"
      ],
      "properties": {
        "createdAt": {
          "maxLength": 64,
          "type": "string"
        },
        "externalUrl": {
          "maxLength": 2048,
          "type": "string"
        },
        "isStoreManaged": {
          "type": "boolean"
        },
        "links": {
          "items": {
            "ref": "#listingLinkRow",
            "type": "ref"
          },
          "type": "array"
        },
        "listing": {
          "ref": "#listingCardGet",
          "type": "ref"
        },
        "productAccountDid": {
          "maxLength": 2048,
          "type": "string"
        },
        "repoDid": {
          "maxLength": 2048,
          "type": "string"
        },
        "screenshots": {
          "items": {
            "maxLength": 4096,
            "type": "string"
          },
          "type": "array"
        },
        "sourceFullDescription": {
          "maxLength": 20000,
          "type": "string"
        },
        "sourceTagline": {
          "maxLength": 20000,
          "type": "string"
        },
        "sourceUrl": {
          "maxLength": 8192,
          "type": "string"
        },
        "updatedAt": {
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "listing",
        "isStoreManaged",
        "repoDid",
        "productAccountDid",
        "sourceTagline",
        "sourceFullDescription",
        "externalUrl",
        "sourceUrl",
        "createdAt",
        "updatedAt"
      ],
      "type": "object"
    },
    "listingLinkRow": {
      "properties": {
        "label": {
          "maxLength": 640,
          "type": "string"
        },
        "uri": {
          "maxLength": 2048,
          "type": "string"
        }
      },
      "required": [
        "uri"
      ],
      "type": "object"
    },
    "main": {
      "description": "Fetch one public verified listing. Provide exactly one of `uri` (fyi.atstore.listing.detail AT URI) or `externalUrl` (unique storefront URL); `externalUrl` uses the same matching rules as the former resolve endpoint.",
      "errors": [
        {
          "name": "ListingNotFound"
        },
        {
          "name": "InvalidParams"
        },
        {
          "name": "AmbiguousResolution"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "ref": "#listingDetailResponse",
          "type": "ref"
        }
      },
      "parameters": {
        "properties": {
          "externalUrl": {
            "description": "Listing external_url / product URL as stored on the record; must match at most one public listing.",
            "maxLength": 2048,
            "type": "string"
          },
          "uri": {
            "description": "AT URI of the fyi.atstore.listing.detail record.",
            "format": "at-uri",
            "maxLength": 2560,
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.atstore.directory.getListing",
  "lexicon": 1
}