API ReferenceListings

Set deliverables

Replace all deliverables on a draft listing. Accepts an array of up to 3 deliverables (file, url, text). File tokens must be obtained via POST /v1/files first. Old file deliverables are automatically cleaned up from storage.

Authentication

AuthorizationBearer

API key (lb_ prefix). Pass as: Authorization: Bearer lb_...

Path parameters

listing_idstringRequired
Listing ID.

Request

This endpoint expects an object.
deliverableslist of objectsRequired
Array of deliverables. Max 3. Mixed types allowed.

Response

Successful Response
idstring
Unique identifier
slugstring
URL slug for the product page
namestring
Product name shown on the product page
highlightslist of strings

Bullet-point features shown as badges on the product page.

priceinteger
Price in cents (smallest currency unit). Examples: $5 = 500, $29 = 2900, $99.99 = 9999.
content_typeenum

Content type: static (pre-attached content, ListBee delivers), generated (content created after payment, ListBee delivers), webhook (paid order handed to seller’s system).

Allowed values:
has_coverboolean

True if a cover image exists (uploaded or generated)

statusenum
Current listing status
Allowed values:
readinessobject

Monetization readiness. sellable is true when buyers can complete a purchase. If false, actions lists what’s needed with kind (api/human), resolve details, and next points to the highest-priority action.

created_atdatetime
Time at which the listing was created
object"listing"

Object type identifier. Always listing.

descriptionstring or null
Product description shown on the product page. Plain text.
taglinestring or null
Short tagline shown below the product name on the product page.
ctastring or null
Buy button text on the product page. Defaults to 'Buy Now' if omitted.
deliverableslist of objects

Deliverables pre-attached to this listing. Required for static content_type — ListBee delivers these to buyers on payment. Empty for generated (content created per-order) and webhook (seller handles delivery) listings.

checkout_schemalist of objects or null
Custom fields collected from the buyer at checkout
compare_at_priceinteger or null
Strikethrough price in smallest currency unit
badgeslist of strings

Short promotional badges shown on the product page (e.g. ‘Best seller’, ‘Limited time’).

cover_blurenum
Cover image blur mode. 'true' always blurs, 'false' never blurs, 'auto' blurs when deliverable is an image file.
Allowed values:
ratingdouble or null

Seller-provided aggregate star rating (1-5). Shown on the product page.

rating_countinteger or null

Seller-provided review or purchase count shown alongside the rating on the product page.

reviewslist of objects

Featured review cards shown on the product page. Seller-provided, not buyer-submitted.

faqslist of objects
FAQ accordion shown on the product page. Answers common buyer questions.
metadatamap from strings to any or null

Arbitrary key-value pairs forwarded in webhook event payloads. Set at creation or update.

utm_sourcestring or null
UTM source tag for Google Analytics
utm_mediumstring or null
UTM medium tag for Google Analytics
utm_campaignstring or null
UTM campaign tag for Google Analytics
stockinteger or null

Stock quantity. null = unlimited, 0 = out of stock. Auto-decrements on each order.

urlstring or null

Full product page URL — share this with buyers

embed_urlstring or null

Embeddable product page URL — use in iframes. Renders minimal version without header/footer.

Errors

401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error