PublishStatus

What buyers see and what a publish would do.

Fields

productIdstring · guide idrequired
The guide's id.
namestringrequired
The guide's title.
statusstringrequired
draft, published or archived.
draftpublishedarchived
livebooleanrequired
true when the guide is on sale.
publishedobject or nullrequired
What buyers see, or null before the first build.
Show 2 fieldsHide fields
- publishedAtnumberrequired
  When the live version went live (Unix time in milliseconds).
- versionnumber or nullrequired
  The live version's number.
hasUnpublishedChangesbooleanrequired
true when the draft holds changes buyers do not see yet.
lastEditAtnumber or nullrequired
When the draft last changed.
pendingSincenumber or nullrequired
When a publish started building; null when none is running.
blockingarray of PublishGaterequired
The publish gates that are open.
Show 2 fieldsHide fieldsof PublishGate
- codestringrequired
  Which gate is open.
  agreement_outdatedno_spotsmissing_coordinatesmissing_photosno_price
- messagestringrequired
  What to fix, in plain words.
warningsarray of objectsrequired
Problems that do not block: review_due, stale_facts, link_problems.
Show 2 fieldsHide fields
- codestringrequired
  A stable code for the warning (see the readiness guide for the list).
- messagestringrequired
  What it means, in plain words.
canPublishChangesbooleanrequired
true when publish_changes would queue a build now.
nextStepstringrequired
One sentence on what to do next.
reviewUrlstringrequired
The guide in the studio.