resourceByPath

Resolve a URL path to its resource type and ID. Enables headless clients to build dynamic URL-to-resource mappings.

Authentication

Public Access: Accessible with the public API key


{
  resourceByPath(path: String!) {
    type
    id
    alternates {
      # Alternate fields
    }
  }
}

Argument	Type	Required	Description
path	String	Yes	The URL path to resolve (e.g., “/products/my-product” or “/login”)

Returns a Resource object containing the resolved resource type and optional ID. The Resource type includes:

type (ResourceKind!): The type of resource this path resolves to
id (String): The unique identifier of the resource. Null for system pages like login, cart, etc.
alternates ([Alternate]): Alternate language URLs for this resource, used for hreflang links and language switching


query {
  resourceByPath(path: "/products/my-product") {
    type
    id
    alternates {
      locale
      path
    }
  }
}