Feed Settings

Read and update feed generation settings like SEO mode, variant handling, and product ID format.

Get feed settings

GET /v1/feed_settings

Returns the current feed generation settings for your shop.

Required scope: read_settings

Request

curl https://app.simpleproductfeeds.com/v1/feed_settings \
  -H "Authorization: Bearer spf_live_sk_your_key_here"

Response

{
  "data": {
    "object": "feed_settings",
    "seo": false,
    "variants": false,
    "use_shopify_quantity": false,
    "import_unpublish_product": false,
    "id_format": "global"
  }
}

Response fields

FieldTypeDescription
object string Always "feed_settings".
seo boolean Whether SEO-optimized titles and descriptions are enabled.
variants boolean Whether all variants are included (true) or only the first variant per product (false).
use_shopify_quantity boolean Whether to use Shopify inventory quantities for availability.
import_unpublish_product boolean Whether to include unpublished products in the feed.
id_format string Product ID format in the feed: "global" (Shopify global ID), "sku" (product SKU), or "variant" (variant ID).

Update feed settings

PATCH /v1/feed_settings

Updates one or more feed settings. Only include the fields you want to change. Updating settings triggers an automatic feed regeneration.

Required scope: write_settings

Parameters

All parameters are optional. Include only the ones you want to change.

ParameterTypeDescription
seobooleanEnable or disable SEO-optimized output.
variantsbooleanInclude all variants (true) or first variant only (false).
use_shopify_quantitybooleanUse Shopify inventory quantities for availability.
import_unpublish_productbooleanInclude unpublished products in the feed.
id_formatstringProduct ID format: global, sku, or variant.

Request

curl -X PATCH https://app.simpleproductfeeds.com/v1/feed_settings \
  -H "Authorization: Bearer spf_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"variants": true, "id_format": "sku"}'

Response

Returns the updated feed settings object.

Errors

StatusCodeDescription
422validation_failedOne or more settings values are invalid.