Compare desired and observed

Shows what is left to publish and what changed on the marketplace, one group at a time. Use it before publishing or after a listing.external_changed notice. The route only reads what MarketAPI already stores: it does not call the marketplace.

curl "$BACKEND_URL/v1/listings/<listingId>/diff" \
  -H "Authorization: Bearer mk_your_api_key"

The response always has the five groups, in this order: content and catalog (from the MarketplaceProduct), offer, inventory and status (from the offer). One group, shortened:

{
  "group": "offer",
  "state": "pending_publication",
  "changedPaths": ["priceInCents"],
  "desired": { "priceInCents": 489900, "currency": "BRL" },
  "observed": { "priceInCents": 499900, "currency": "BRL" }
}

How to read stateCopy Anchor Link

desired and observed almost always differ: the marketplace adds fields you never sent. So each side is compared with what the last publication confirmed. Only what changed since then counts.

Watch outCopy Anchor Link

• Only content and offer become conflict. In catalog and inventory, with both sides changed, the state is pending_publication: the next publication sends your value. Inventory comes from your balance; to undo a change made there, resend the stock.
• status has no desired value (desired is null). It only goes to external_change when the marketplace changes the status. The reason is in issues.
• changedPaths lists only what you set and that differs from observed: the keys of the value and, inside it, attributes.<key> (in content) and lines.<identity> (in inventory).
• conflict in content or offer always has a record in conflicts to resolve, whoever moved first: the outside change arriving with your edit pending, or your edit arriving after the outside change.

How it fits: Stay in sync.