Ingestion API Usage

Overview

The GraphQL Ingestion API is a powerful tool for adding commerce and content data to Nacelle. This API works with streaming single objects or large bulk operations and re-indexes.

This doc is meant to overview the requests you can make with the Ingestion API. For full details of each query and mutation, load the API into your desktop GraphQL Client and inspect the schema.

Usage and authentication

The Ingestion API can be found at https://ingest.api.nacelle.com/graphql To make use of it, you must provide the following headers in your requests:

  • x-nacelle-space-id (available on the Space API Details page)
  • x-nacelle-source-id (created during the setup process found below)
  • x-nacelle-ingest-token (available on the API details page)

Queries

Since the Ingestion API is primarily for getting data into Nacelle, there's only one query. Every other operation is a mutation.

  • indexStatus
    Get the status of an indexing process

Mutations

  • startIndex
    Programmatically starts an indexing process

  • collectionContentCreate
    Adds collection content entries to the Nacelle index

  • collectionContentDelete
    Removes collection content entries from the Nacelle index

  • collectionContentUpdate
    Updates collection content entries in the Nacelle index

  • collectionCreate
    Adds a collection of entries to the Nacelle index

  • collectionDelete
    Removes collections from the Nacelle index

  • collectionUpdate
    Updates collections in the Nacelle index

  • contentCreate
    Adds content entries to the Nacelle index

  • contentDelete
    Removes content entries from the Nacelle index

  • contentUpdate
    Updates content entries in the Nacelle index

  • productCreate
    Adds product entries to the Nacelle index

  • productDelete
    Removes product entries from the Nacelle index

  • productUpdate
    Updates product entries in the Nacelle index

  • productContentCreate
    Adds product content entries to the Nacelle index

  • productContentDelete
    Removes product content entries from the Nacelle index

  • productContentUpdate
    Updates product content entries in the Nacelle index

  • productVariantCreate
    Adds product variant entries to the Nacelle index

  • productVariantDelete
    Removes product variant entries from the Nacelle index

  • productVariantUpdate
    Updates product variant entries in the Nacelle index

  • productVariantContentCreate
    Adds product variant content entries to the Nacelle index

  • productVariantContentDelete
    Removes product variant content entries from the Nacelle index

  • productVariantContentUpdate
    Updates product variant content entries in the Nacelle index