The Ingest API powers data ingestion in your Frontstack project. Pre-built connectors automatically use this API to process updates from your data pipeline into your Data Feeds.

For scenarios where you need more control or when a pre-built connector isn’t available, you can directly interact with the Ingest API through a Custom Integration.

​
Authentication

All requests to the Ingest API need to be authenticated. You will receive the API key during Frontstack onboarding.

Provide this API key as the Authorization HTTP header in your Ingest API requests.

​
Upsert

The “Upsert” endpoint receives a POST request with a JSON object in its body and returns (with status code 200) a JSON object containing a correlation ID, e.g. like this:

// POST
{"correlation-id": "22c8f6f9-2a62-4e18-81a5-33c207dd967d"}

This correlation ID is used in Frontstack’s processing to track a particular data change. If you have questions about the processing of a data change, you should provide this correlation ID to us.

It replaces the previous record version with the same source ID with the new one.

​
Patch

The “Patch” endpoint receives a POST request with a JSON object in its body and returns (with status code 200) a JSON object containing a correlation ID, e.g. like this:

Single record

// PATCH
{"id":"my-id-1","some-field":"foo":}

or multiple records

// PATCH
[
  {"id":"my-id-1","some-field":"foo":},
  {"id":"my-id-2","other-field":"bar":}
]

It incrementally updates an existing record and merges objects and scalar values (numeric arrays will be overridden).

​
Delete

The “Delete” endpoint receives a POST request with a JSON object in its body and returns (with status code 200) a JSON object containing a correlation ID, like the Upsert endpoint does as well.

The request body must contain a id field, which is the source ID of the record to be deleted. See this example:

// DELETE
{"id": "my-product-123"}

You may alternatively provide a JSON list containing one or multiple source IDs in the request body, like this:

// DELETE
[{"id": "my-product-123"}, {"id": "my-product-456"}]