ChemPal Documentation - v1.7.0
    Preparing search index...

    Interface ShopifySearchResponse

    Represents the full response from a Shopify GraphQL product search query. May contain partial errors (e.g. permission-denied fields) alongside valid data.

    interface ShopifySearchResponse {
        errors?: {
            message: string;
            locations?: { line: number; column: number }[];
            path?: (string | number)[];
            extensions?: {
                code: string;
                documentation: string;
                requiredAccess: string;
            };
        }[];
        data: {
            products: {
                pageInfo?: { hasNextPage: boolean; endCursor: null
                | string };
                edges: { node: ShopifyProductNode }[];
            };
        };
        extensions?: { cost?: { requestedQueryCost: number } };
    }
    Index

    Properties

    errors? data extensions?

    Properties

    errors?: {
        message: string;
        locations?: { line: number; column: number }[];
        path?: (string | number)[];
        extensions?: {
            code: string;
            documentation: string;
            requiredAccess: string;
        };
    }[]

    Array of GraphQL errors (e.g. permission denied for specific fields)

    Type declaration

    • message: string

      Human-readable error message

    • Optionallocations?: { line: number; column: number }[]

      Source locations in the query where the error occurred

    • Optionalpath?: (string | number)[]

      Path to the field that caused the error

    • Optionalextensions?: { code: string; documentation: string; requiredAccess: string }

      Additional error metadata

      • code: string

        Error code (e.g. "ACCESS_DENIED")

      • documentation: string

        Link to relevant documentation

      • requiredAccess: string

        Description of required access scope

    data: {
        products: {
            pageInfo?: { hasNextPage: boolean; endCursor: null | string };
            edges: { node: ShopifyProductNode }[];
        };
    }

    The query result data

    Type declaration

    • products: {
          pageInfo?: { hasNextPage: boolean; endCursor: null | string };
          edges: { node: ShopifyProductNode }[];
      }

      Product search results in relay-style edges/node format

      • OptionalpageInfo?: { hasNextPage: boolean; endCursor: null | string }

        Relay pagination info

      • edges: { node: ShopifyProductNode }[]

        Array of product edge objects

    extensions?: { cost?: { requestedQueryCost: number } }

    Query cost and performance metadata

    Type declaration

    • Optionalcost?: { requestedQueryCost: number }

      API cost information

      • requestedQueryCost: number

        The computed cost of the query

    Settings

    Member Visibility

    On This Page

    Properties