Skip to main content

Set Channel Default Pricing Sync Profile

PUT 

/api/v2/sales-channels/:integrationInstance/prices/profile

Set or clear the channel's default pricing sync profile — the policy every listing on the channel pushes under unless its product or the listing itself carries a profile of its own.

Required scope: integrations:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Changing the default re-prices the whole channel in the background (tracked_job_log_id) and forces the channel's next push to be a preview (require_dry_run_first: true), so the effect of the new policy is visible before anything is transmitted. Sending the profile the channel already has does neither.

Authentication: Requires Bearer token.

Requires the integrations.update permission (API tokens: integrations:write scope).

Request body:

  • pricing_sync_profile_id (integer|null, required — the key must be present): the profile to make the default, or null to return the channel to its inline settings. An archived profile is refused (422).

Response data:

  • pricing_sync_profile (object|null): the profile now in force, in the same shape as Get Pricing Sync Profile, or null when cleared
  • require_dry_run_first (boolean): the next push on this channel will run as a preview
  • tracked_job_log_id (integer|null): the background re-price started by this change

Request

Responses

OK

Response Headers
    Content-Type