Skip to main content

Get Pricing Sync Profile

GET 
/api/v2/pricing-sync-profiles/:pricingSyncProfile

Get a single pricing sync profile, including its current usage counts.

Required scope: integrations:read

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

Authentication: Requires Bearer token.

Requires the integrations.view permission (API tokens: integrations:read scope).

Each profile carries:

  • id, name
  • sequence_tier_ids (array of integers) and sequence (array of {id, name}, name null when the level no longer exists)
  • floor / ceiling: {type, value, tier_id, tier_name, action} — action is the action actually in force (block or adjust; null when the type is none)
  • max_delta_pct (number|null), max_delta_action (skip or block_run)
  • automated_pricing_rule_id (string|null)
  • summary (string): the one-line description of the policy
  • missing_tier_count (integer): sequence steps naming a level that no longer exists
  • usage: {channel_defaults, products, listings, listings_effective, total} — where the profile is assigned directly (total is the sum of the first three) and how many listings it effectively governs after inheritance
  • is_archived, archived_at, created_by ({id, name} or null), created_at, updated_at

Request​

Responses​

OK

Response Headers
    Content-Type