This API allows you to extract product information in a structured way from your catalog and the web.

​
Key Queries

​
getProduct

Fetch a single product based on a specified query and type from the web.

getProduct(query: String!, type: QueryType!, targetFormat: TargetFormatInput): JSON

Parameters:

  • query: The search term or identifier for the product.
  • type: The type of query (Link, Text, GTIN, or ImageLink).
  • targetFormat: Specifies the structure of the returned data, either as ID or object array, see TargetFormatInput. If not specified, the default target format will be used.

​
Example:

query Query($query: String!, $type: QueryType!, $targetFormat: TargetFormatInput) {
  getProduct(query: $query, type: $type, targetFormat: $targetFormat)
}

variables: {
  "query": "https://www.amazon.com/Creuset-Signature-Enameled-Cast-Iron-Stainless/dp/B00VA5HG0Q",
  "type": "Link",
  "targetFormat": {
    // define the structure of the returned data
    "data": {  
      "name": {
        "type": "string",
      },
      "brand": {
        "type": "string",
      },
      "price": {
        "type": "number",
      },
    },
    // alternatively use a saved format
    "id": "12"
    // if no target format is specified, your default format will be used.
  }
}

This query allows you to search for any product using various identifiers. The targetFormat parameter lets you define the structure of the returned data, ensuring you get exactly the fields you need in the format you specify.

​
findInCatalog

Search your catalog for products matching the given query, see Search.

​
getFromSource

Retrieve products from a specified source, applying a target format to the results.

getFromSource(source: SourceInput!, targetFormat: TargetFormatInput): [JSON!]

Parameters:

  • source: Defines the data source to fetch products from, see SourceInput.
  • targetFormat: Specifies the structure of the returned data, either as ID or object array, see TargetFormatInput. If not specified, the default target format will be used.

​
Example:

query {
  getFromSource(
    source: {
      sourceRequest: {
        name: "My Shopify Store",
        type: Shopify,
        url: "https://mystore.myshopify.com"
      }
    },
    targetFormat: {
      id: "4545", # use an ID from the saved target format
      data: {     # alternatively, submit the target format as a JSON object
        "Name": {
          "type": "string",
          "description": "Product name",
          "attributes": ["required", "capitalized"]
        },
        "Price": {
          "type": "number",
          "description": "Product price",
          "attributes": ["required", "positiveNumber", "currency"]
        },
        "Description": {
          "type": "string",
          "description": "Product description"
        }
      }
    }
  )
}

​
getProductPreview

Preview product data from a specified source without applying any transformations.

getProductPreview(source: SourceInput!): [JSON!]

Parameters:

  • source: Defines the data source to fetch the product preview from.

For details on the input type, see SourceInput.

​
Example:

query {
  getProductPreview(
    source: {
      sourceRequest: {
        name: "My Custom Feed",
        type: Request,
        url: "https://mycustomfeed.com/products"
      }
    }
  )
}
Getting StartedData Sources