Archive a listing (terminal)

Move a listing to ARCHIVED terminal state. The listing can no longer be published or sold. Idempotent — calling on an already-archived listing is a no-op. Applies to both DRAFT and PUBLISHED listings.

Authentication

AuthorizationBearer

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

Path parameters

listing_idstringRequired

Listing ID (lst_ prefixed).

Response

Successful Response

idstring

Unique listing ID (lst_ prefixed).

short_codestring

Short code for the product page URL

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.

fulfillment_modeenum

STATIC: pre-baked deliverable delivered at order.paid. ASYNC: agent delivers via /v1/orders/{id}/fulfill.

Allowed values:

has_coverboolean

True if a cover image exists (uploaded or generated)

signing_secret_previewstring

Last 4 characters of the listing signing secret. Use this to identify the active secret without revealing it. The full secret is only returned once: on create (in signing_secret) or after rotation.

statusenum

Current listing status. Values: draft (editable, not yet live), published (live, accepting orders), archived (terminal — removed from sale).

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.

deliverableobject or null

Pre-baked deliverable for STATIC listings. Null for ASYNC listings.

agent_callback_urlstring or null

Per-listing webhook URL receiving order events signed with signing_secret.

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 for image deliverables.

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

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

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://api.listbee.so/v1/listings/listing_id/archive"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.post(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": "lst_7kQ2xY9mN3pR5tW1vB8a",
3	"short_code": "seo-playbook",
4	"name": "SEO Playbook 2026",
5	"highlights": [
6	"50+ pages",
7	"Actionable tips"
8	],
9	"price": 500,
10	"fulfillment_mode": "async",
11	"has_cover": true,
12	"signing_secret_preview": "a1b2",
13	"status": "published",
14	"readiness": {
15	"sellable": true,
16	"actions": [
17	{
18	"code": "stripe_connect_required",
19	"kind": "api",
20	"priority": "required",
21	"message": "Set Stripe secret key to accept payments",
22	"resolve": {
23	"method": "POST",
24	"endpoint": "/v1/account/stripe-key",
25	"url": "https://console.listbee.so/connect/stripe",
26	"params": {
27	"secret_key": "sk_live_..."
28	}
29	}
30	}
31	],
32	"next": "stripe_connect_required"
33	},
34	"created_at": "2026-04-01T12:00:00Z",
35	"object": "listing",
36	"description": "A comprehensive guide to modern SEO.",
37	"tagline": "Updated for 2026 algorithm changes",
38	"cta": "Get Instant Access",
39	"deliverable": {
40	"id": "del_7kQ2xY9mN3pR5tW1vB8a01",
41	"type": "url",
42	"status": "ready",
43	"object": "deliverable",
44	"url": "https://example.com/secret",
45	"content": "Buy signal: AAPL"
46	},
47	"agent_callback_url": "https://my-agent.com/fulfill",
48	"checkout_schema": [
49	{
50	"key": "size",
51	"type": "text",
52	"label": "Shoe size",
53	"required": true,
54	"options": [
55	"S",
56	"M",
57	"L"
58	],
59	"sort_order": 0
60	}
61	],
62	"compare_at_price": 3900,
63	"badges": [
64	"Limited time"
65	],
66	"cover_blur": "auto",
67	"rating": 4.8,
68	"rating_count": 1243,
69	"reviews": [],
70	"faqs": [],
71	"metadata": {
72	"source": "n8n"
73	},
74	"utm_source": "google",
75	"utm_medium": "cpc",
76	"utm_campaign": "spring-sale",
77	"url": "https://buy.listbee.so/seo-playbook",
78	"embed_url": "https://buy.listbee.so/seo-playbook?embed=true"
79	}