For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update Merchant Catalog Settings

Updates the catalog-related toggles for a merchant, such as offer visibility and auto-publish settings.

Update Merchant Catalog Settings

patch

Partially updates the catalog toggles (JSON Merge Patch). truify_offer_visibility is channel/admin-only; merchant tokens attempting to set it receive a 403.

Path parameters
merchant_idinteger · int32Required
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body

Catalog-related toggles exposed as merchant configuration.

truify_offer_visibilityboolean · nullableOptional

When true, force all offer visibility to true during catalog sync. Channel/admin-only; cannot be set by merchant users.

Example: true
auto_publish_offersboolean · nullableOptional

When true, auto-publish offers after creation or update.

Example: false
Responses
200

The updated catalog settings.

application/json

Catalog-related toggles exposed as merchant configuration.

truify_offer_visibilityboolean · nullableOptional

When true, force all offer visibility to true during catalog sync. Channel/admin-only; cannot be set by merchant users.

Example: true
auto_publish_offersboolean · nullableOptional

When true, auto-publish offers after creation or update.

Example: false
patch/merchants/{merchant_id}/catalog-settings
PATCH /v1/merchants/{merchant_id}/catalog-settings HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "auto_publish_offers": false
}
200

The updated catalog settings.

{
  "truify_offer_visibility": true,
  "auto_publish_offers": false
}

Last updated

Was this helpful?