{"components":{"parameters":{"IdempotencyKey":{"description":"Unique key per logical request (1-255 chars). Retries replay the first response for 24h.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"type":"string"}}},"responses":{"Forbidden":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API key is read-only."},"NotFound":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found."},"Oversold":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Code `oversold`: the item has no stock left, so this may be a double sale. Cancel one order or adjust stock, then retry."},"RateLimited":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests; see `retry-after`."},"Unauthorized":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid or revoked API key."},"ValidationFailed":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid fields; see `details`."}},"schemas":{"ToShipSnapshot":{"properties":{"count":{"description":"Orders waiting to ship. Ignored when `error` is set, so a failure cannot zero the last count.","minimum":0,"type":["integer","null"]},"error":{"description":"Set when the site could not be read. The previous waiting list is kept.","type":["string","null"]},"items":{"description":"Ignored when `error` is set.","items":{"$ref":"#/components/schemas/ToShipOrder"},"type":"array"},"platform":{"enum":["poshmark","ebay","depop","mercari","vinted","facebook"],"type":"string"}},"required":["platform"],"type":"object"},"WorkerTaskResult":{"properties":{"device_token":{"type":"string"},"error":{"type":["string","null"]},"progress":{"type":"object"},"status":{"enum":["running","succeeded","failed","cancelled"],"type":"string"}},"required":["status"],"type":"object"},"SyncSaleCreate":{"description":"Send `platform` + `external_listing_id`, or `listing_id`, `item_id` or `sku`.","properties":{"buyer":{"type":"string"},"external_listing_id":{"description":"The platform's listing id.","type":"string"},"external_order_id":{"description":"The platform's order id. Makes the call safe to repeat.","type":"string"},"item_id":{"type":"integer"},"listing_id":{"type":"integer"},"notes":{"type":"string"},"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"platform_fees":{"description":"Total fees the platform took.","examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"quantity":{"default":1,"minimum":1,"type":"integer"},"sale_price":{"examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"shipping_charged":{"description":"Shipping the buyer paid.","examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"shipping_cost":{"description":"What you paid for postage.","examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"sku":{"type":"string"},"sold_at":{"description":"Defaults to now.","format":"date-time","type":"string"}},"required":["sale_price"],"type":"object"},"SalesSyncOrder":{"properties":{"external_order_id":{"type":["string","null"]},"id":{"type":"integer"},"status":{"type":"string"}},"type":"object"},"WorkerRunCreate":{"properties":{"details":{"type":"object"},"device_token":{"type":"string"},"done":{"minimum":0,"type":"integer"},"error":{"type":["string","null"]},"failed_count":{"minimum":0,"type":"integer"},"finished_at":{"format":"date-time","type":"string"},"job":{"enum":["offers_to_likers","favorite_offers","flyp_send_offers","bulk_offer","follow","share","reactivate_inactive","offers_inbox","offer_history","chat_offers","posh_newsfeed_likes","posh_listing_sweep","depop_likes","post_listings","sync_listings","price_drop","fix_check","sold_check","cross_check","mark_sold","sales","profit","payouts","to_ship","store_size"],"type":"string"},"marketplace_account_id":{"type":"integer"},"mode":{"enum":["full","quick"],"type":"string"},"people_count":{"minimum":0,"type":"integer"},"sent_count":{"minimum":0,"type":"integer"},"skipped":{"type":"object"},"started_at":{"format":"date-time","type":"string"},"status":{"enum":["running","succeeded","problem","failed","stopped","timed_out"],"type":"string"},"summary":{"type":"string"},"total":{"minimum":0,"type":"integer"},"trigger":{"enum":["scheduled","manual","turned_on","job"],"type":"string"}},"required":["job"],"type":"object"},"WorkerRunUpdate":{"properties":{"details":{"type":"object"},"device_token":{"type":"string"},"done":{"minimum":0,"type":"integer"},"error":{"type":["string","null"]},"failed_count":{"minimum":0,"type":"integer"},"finished_at":{"format":"date-time","type":"string"},"mode":{"enum":["full","quick"],"type":"string"},"people_count":{"minimum":0,"type":"integer"},"sent_count":{"minimum":0,"type":"integer"},"skipped":{"type":"object"},"status":{"enum":["running","succeeded","problem","failed","stopped","timed_out"],"type":"string"},"summary":{"type":"string"},"total":{"minimum":0,"type":"integer"}},"type":"object"},"WorkerDeviceCreate":{"properties":{"name":{"maxLength":100,"minLength":1,"type":"string"},"version":{"maxLength":100,"type":["string","null"]}},"required":["name"],"type":"object"},"WorkerSyncWrite":{"properties":{"backfilled":{"type":"boolean"},"blocked_until":{"format":"date-time","type":"string"},"cursor":{"type":"object"},"items_scanned":{"minimum":0,"type":"integer"},"last_attempt_at":{"format":"date-time","type":"string"},"last_error":{"type":["string","null"]},"last_full_at":{"format":"date-time","type":"string"},"last_success_at":{"format":"date-time","type":"string"},"paused":{"type":"boolean"},"progress_note":{"type":"string"},"schema_version":{"minimum":1,"type":"integer"},"watermark_at":{"format":"date-time","type":"string"}},"type":"object"},"WorkerTask":{"properties":{"action":{"type":["string","null"]},"attempts":{"type":"integer"},"automation_run_id":{"type":["integer","null"]},"finished_at":{"format":"date-time","type":["string","null"]},"id":{"type":"integer"},"job":{"type":["string","null"]},"kind":{"enum":["listing","account"],"type":"string"},"last_error":{"type":["string","null"]},"listing_id":{"type":["integer","null"]},"locked_at":{"format":"date-time","type":["string","null"]},"locked_by_device_id":{"type":["integer","null"]},"marketplace_account_id":{"type":["integer","null"]},"marketplace_id":{"type":["integer","null"]},"payload":{"type":"object"},"priority":{"type":"integer"},"progress":{"type":["object","null"]},"run_after":{"format":"date-time","type":["string","null"]},"status":{"enum":["pending","running","succeeded","failed","cancelled"],"type":"string"},"stop_requested":{"type":["boolean","null"]}},"type":"object"},"WorkerScheduleWrite":{"properties":{"daily_at":{"examples":["09:15:00"],"format":"time","type":"string"},"enabled":{"type":"boolean"},"interval_minutes":{"minimum":1,"type":"integer"},"job":{"enum":["offers_to_likers","favorite_offers","flyp_send_offers","bulk_offer","follow","share","reactivate_inactive","offers_inbox","offer_history","chat_offers","posh_newsfeed_likes","posh_listing_sweep","depop_likes","post_listings","sync_listings","price_drop","fix_check","sold_check","cross_check","mark_sold","sales","profit","payouts","to_ship","store_size"],"type":"string"},"marketplace_account_id":{"type":"integer"},"next_run_at":{"format":"date-time","type":"string"}},"required":["job"],"type":"object"},"AutoOfferRunResult":{"properties":{"details":{"type":"object"},"finished_at":{"format":"date-time","type":["string","null"]},"id":{"type":"integer"},"job":{"enum":["offers_to_likers","favorite_offers","flyp_send_offers","reactivate_inactive","bulk_offer","follow","share"],"type":"string"},"marketplace":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"people_count":{"type":"integer"},"sent_count":{"type":"integer"},"started_at":{"format":"date-time","type":"string"},"status":{"enum":["running","succeeded","problem","failed","stopped","timed_out"],"type":"string"},"summary":{"type":["string","null"]},"trigger":{"enum":["scheduled","manual","turned_on","job"],"type":"string"}},"type":"object"},"WorkerRateWrite":{"properties":{"action":{"enum":["follow","offer","post","share"],"type":"string"},"day":{"format":"date","type":"string"},"n":{"minimum":0,"type":"integer"}},"required":["action","n"],"type":"object"},"SalesSync":{"properties":{"from":{"format":"date-time","type":"string"},"orders":{"items":{"properties":{"external_order_id":{"type":"string"},"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"}},"type":"object"},"type":"array"},"to":{"format":"date-time","type":"string"}},"required":["from","to","orders"],"type":"object"},"PriceDropStepWrite":{"properties":{"error":{"type":["string","null"]},"listing_id":{"type":"integer"},"status":{"enum":["started","done","failed","locked"],"type":"string"},"step":{"enum":["price","relist","delist"],"type":"string"},"target_price_cents":{"description":"Integer cents.","type":["integer","null"]}},"type":"object"},"AutoOfferAttemptResult":{"properties":{"amount_cents":{"type":["integer","null"]},"attempted_at":{"format":"date-time","type":"string"},"buyer_external_id":{"type":["string","null"]},"external_listing_id":{"type":["string","null"]},"id":{"type":"integer"},"listing_price_cents":{"type":["integer","null"]},"offer_id":{"type":["integer","null"]},"outcome":{"enum":["sent","unconfirmed","not_sent","refused","failed","skipped"],"type":"string"},"reason":{"type":["string","null"]}},"type":"object"},"OfferResult":{"properties":{"blocked":{"type":"boolean"},"counter_blocked":{"type":"boolean"},"decided_by":{"enum":["seller","buyer","rule","marketplace"],"type":"string"},"error":{"type":["string","null"]},"status":{"enum":["pending","accepted","declined","countered","expired","cancelled"],"type":"string"}},"type":"object"},"AutoOfferListing":{"properties":{"external_id":{"type":"string"},"likes":{"type":["integer","null"]},"marketplace_last_otl_cents":{"description":"Mercari's last offer to likers, in integer cents. A new price must be under it.","type":"integer"},"price_cents":{"description":"Listing price in integer cents.","type":"integer"},"title":{"type":["string","null"]}},"required":["external_id","price_cents"],"type":"object"},"ListingUpdate":{"properties":{"external_id":{"type":"string"},"listed_at":{"format":"date-time","type":"string"},"price":{"description":"This platform's price, only if it differs from the item's. Omit to use the item price; null clears an override. Matching the item price is treated as no override.","examples":["45.00"],"type":["string","null"]},"status":{"enum":["active","needs_delist","delisted","sold"],"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"OfferInboxResult":{"properties":{"offers":{"items":{"$ref":"#/components/schemas/Offer"},"type":"array"},"threads":{"items":{"$ref":"#/components/schemas/OfferThread"},"type":"array"}},"type":"object"},"WorkerHeartbeat":{"properties":{"device_token":{"description":"Used when `X-Device-Token` is absent. The header wins.","type":"string"},"signed_in":{"additionalProperties":{"format":"date-time","type":"string"},"description":"Account id to the last time that account was signed in.","type":"object"},"version":{"maxLength":100,"minLength":1,"type":"string"}},"required":["version"],"type":"object"},"WorkerLeaseRequest":{"properties":{"device_token":{"type":"string"},"seconds":{"maximum":86400,"minimum":1,"type":"integer"}},"type":"object"},"OfferStats":{"properties":{"accepted":{"type":"integer"},"countered":{"type":"integer"},"counters_accepted":{"type":"integer"},"deal_rate":{"type":"number"},"received":{"type":"integer"},"waiting":{"type":"integer"}},"type":"object"},"Error":{"properties":{"error":{"properties":{"code":{"examples":["validation_failed"],"type":"string"},"details":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"examples":[{"title":["can't be blank"]}],"type":"object"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"},"OfferInboxThread":{"properties":{"blocked":{"type":"boolean"},"counter_blocked":{"type":"boolean"},"external_listing_id":{"type":["string","null"]},"external_thread_id":{"type":"string"},"history_partial":{"type":"boolean"},"offers":{"items":{"$ref":"#/components/schemas/OfferInboxOffer"},"type":"array"}},"type":"object"},"CrosslistFields":{"properties":{"category":{"description":"Marketplace category id, stored as the listing's external category.","type":["string","null"]},"category_id":{"type":["string","null"]},"description":{"type":["string","null"]},"external_category_id":{"type":["string","null"]},"photo_ids":{"description":"Item photo ids in display order. The first is the cover.","items":{"type":"integer"},"type":"array"},"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"price":{"examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"title":{"type":["string","null"]}},"type":"object"},"AutoOffer":{"properties":{"amount_cents":{"description":"Offer amount in integer cents.","type":"integer"},"automation_run_id":{"type":["integer","null"]},"currency":{"type":"string"},"external_listing_id":{"type":["string","null"]},"id":{"type":"integer"},"initiated_by":{"enum":["buyer","seller"],"type":"string"},"kind":{"enum":["buyer_offer","counter","offer_to_likers","private_offer"],"type":"string"},"listing_price_cents":{"description":"Listing price in integer cents when the offer was made.","type":"integer"},"listing_title":{"type":["string","null"]},"marketplace":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"offered_at":{"format":"date-time","type":"string"},"recipient_count":{"type":["integer","null"]},"recipients":{"items":{"$ref":"#/components/schemas/AutoOfferRecipient"},"type":"array"},"status":{"enum":["pending","accepted","declined","countered","expired","cancelled"],"type":"string"},"verified_at":{"format":"date-time","type":["string","null"]},"via":{"enum":["direct","flyp","ui_automation","bulk_tool","offer_desk","marketplace_app",null],"type":["string","null"]}},"type":"object"},"ListingIssueResolve":{"properties":{"resolution":{"type":"string"}},"type":"object"},"AutoOfferStats":{"properties":{"buyer_offers":{"description":"Buyer offers in the range. Offer-to-likers is not included.","type":"integer"},"items":{"description":"Seller sends in the range.","type":"integer"},"marketplaces":{"additionalProperties":{"$ref":"#/components/schemas/AutoOfferMarketplaceStats"},"type":"object"},"people":{"description":"Recipients of those sends. Flyp counts as zero.","type":"integer"}},"type":"object"},"AutoOfferSendResult":{"properties":{"attempt":{"oneOf":[{"$ref":"#/components/schemas/AutoOfferAttemptResult"},{"type":"null"}]},"offer":{"oneOf":[{"$ref":"#/components/schemas/AutoOffer"},{"type":"null"}]},"refused":{"type":"boolean"}},"type":"object"},"SalesSyncResult":{"properties":{"cancelled":{"items":{"$ref":"#/components/schemas/SalesSyncOrder"},"type":"array"},"kept":{"items":{"$ref":"#/components/schemas/SalesSyncOrder"},"type":"array"}},"type":"object"},"PayoutSync":{"properties":{"paused":{"type":"boolean"}},"required":["paused"],"type":"object"},"ItemUpdate":{"properties":{"acquired_on":{"format":"date","type":["string","null"]},"brand":{"type":["string","null"]},"category":{"type":["string","null"]},"color":{"type":["string","null"]},"condition":{"enum":["new_with_tags","new_without_tags","new","like_new","good","fair","poor","for_parts",null]},"condition_notes":{"description":"Condition details; fills %%CONDITION%% and eBay's condition description.","type":["string","null"]},"cost":{"description":"What you paid (cost of goods).","examples":["45.00"],"type":["string","null"]},"department":{"enum":["women","men","kids","unisex","home","pets","other",null]},"description":{"type":["string","null"]},"height_in":{"description":"Package height, inches.","type":["string","null"]},"length_in":{"description":"Package length, inches.","type":["string","null"]},"listing_template_id":{"description":"The listing template this item uses (see /templates). One per item; a template for one platform only renders there. null for none.","type":["integer","null"]},"notes":{"type":["string","null"]},"original_price":{"description":"Original retail price (MSRP).","examples":["45.00"],"type":["string","null"]},"package_preset_id":{"description":"One of the seller's saved packages (Settings → Lister). weight_oz and the dimensions, when set, override it; with neither, the default package is used.","type":["string","null"]},"photo_urls":{"items":{"type":"string"},"type":"array"},"platform_fields":{"description":"Per-platform extras on top of the shared template. On update, only the platforms and keys you send change; send a key as null or \"\" to clear it. Unknown keys are ignored.","examples":[{"ebay":{"best_offer":true,"material":"Polyester"},"etsy":{"when_made":"2010s","who_made":"Another company or person"}}],"properties":{"depop":{"properties":{"age":{"description":"Age","enum":["Modern","2010s","2000s","1990s","1980s","1970s","1960s","1950s","Older"],"type":"string"},"category":{"description":"Category Required by the platform.","type":"string"},"source":{"description":"Source","enum":["Vintage","Preloved","Deadstock","Handmade"],"type":"string"},"styles":{"description":"Styles Up to 3, e.g. Vintage, Streetwear","items":{"type":"string"},"type":"array"}},"type":"object"},"ebay":{"properties":{"ad_rate":{"description":"Ad rate (%) Promoted Listings General rate, applied once the listing is live. Leave blank for the default.","examples":["7.5"],"type":"string"},"best_offer":{"description":"Accept Best Offer Leave unset to follow the seller's default in Lister settings.","type":"boolean"},"category_id":{"description":"eBay category ID The leaf category number from eBay's category picker. Required by the platform.","type":"string"},"format":{"description":"Format Leave unset to follow the seller's default in Lister settings.","enum":["Buy It Now","Auction"],"type":"string"},"handling_days":{"description":"Handling time Leave unset to follow the seller's default, or the shipping policy's when that's unset too.","enum":["Same day","1 business day","2 business days","3 business days"],"type":"string"},"item_specifics":{"additionalProperties":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"description":"Item specifics eBay's item specifics for the category (US Shoe Size, Model, ...), by name.","examples":[{"Season":["Spring","Fall"],"US Shoe Size":"7.5"}],"type":"object"},"material":{"description":"Material","type":"string"},"offer_auto_accept":{"description":"Auto-accept offers at Offers at or above this are accepted. Leave blank for the default in Lister settings.","examples":["40.00"],"type":"string"},"offer_minimum":{"description":"Decline offers below Offers below this are declined. Leave blank for the default in Lister settings.","examples":["40.00"],"type":"string"},"pattern":{"description":"Pattern","type":"string"},"style":{"description":"Style e.g. Fleece Jacket, Bomber","type":"string"}},"type":"object"},"etsy":{"properties":{"is_supply":{"description":"What is it?","enum":["A finished product","A supply or tool"],"type":"string"},"materials":{"description":"Materials","items":{"type":"string"},"type":"array"},"section":{"description":"Shop section","type":"string"},"when_made":{"description":"When was it made? Vintage on Etsy means at least 20 years old. Required by the platform.","enum":["Made to order","2020s","2010s","2000s","1990s","1980s","1970s","1960s","1950s","Before 1950"],"type":"string"},"who_made":{"description":"Who made it? Required by the platform.","enum":["I did","A member of my shop","Another company or person"],"type":"string"}},"type":"object"},"facebook":{"properties":{"category":{"description":"Category Required by the platform.","type":"string"},"delivery":{"description":"Delivery","enum":["Shipping","Local pickup","Shipping and local pickup"],"type":"string"}},"type":"object"},"mercari":{"properties":{"category":{"description":"Category Required by the platform.","type":"string"},"floor_price":{"description":"Floor price Lowest price Smart Pricing can drop to.","examples":["40.00"],"type":"string"},"shipping_payer":{"description":"Shipping paid by","enum":["Buyer","Seller"],"type":"string"},"smart_pricing":{"description":"Smart Pricing","type":"boolean"}},"type":"object"},"poshmark":{"properties":{"category":{"description":"Category e.g. Jackets & Coats Required by the platform.","type":"string"},"style_tags":{"description":"Style tags Up to 3, e.g. outdoor, cozy","items":{"type":"string"},"type":"array"},"subcategory":{"description":"Subcategory e.g. Fleece","type":"string"}},"type":"object"},"shopify":{"properties":{"collections":{"description":"Collections","items":{"type":"string"},"type":"array"},"product_type":{"description":"Product type","type":"string"},"vendor":{"description":"Vendor Defaults to the brand.","type":"string"}},"type":"object"},"vinted":{"properties":{"category":{"description":"Category Required by the platform.","type":"string"},"material":{"description":"Material","type":"string"},"parcel_size":{"description":"Parcel size","enum":["Small","Medium","Large"],"type":"string"}},"type":"object"}},"type":"object"},"price":{"description":"Asking price. Every listing uses it unless that listing overrides it.","examples":["45.00"],"type":["string","null"]},"size":{"type":["string","null"]},"sku":{"description":"Unique per account.","maxLength":100,"type":["string","null"]},"source":{"type":["string","null"]},"status":{"enum":["draft","active","sold","archived"],"type":"string"},"tags":{"description":"Keywords/hashtags. Also accepted as a comma-separated string.","items":{"type":"string"},"maxItems":30,"type":"array"},"title":{"maxLength":255,"type":"string"},"weight_oz":{"description":"Packed weight in ounces.","examples":["18.5"],"type":["string","null"]},"width_in":{"description":"Package width, inches.","type":["string","null"]}},"type":"object"},"CrosslistTaxonomy":{"properties":{"attributes":{"items":{"properties":{"category_id":{"type":"string"},"key":{"type":"string"},"label":{"type":["string","null"]},"max_values":{"type":["integer","null"]},"mode":{"type":"string"},"required":{"type":"boolean"},"site":{"type":"string"},"values":{"items":{"properties":{"label":{"type":"string"},"sort_order":{"type":["integer","null"]},"value":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"categories":{"items":{"properties":{"data":{"type":"object"},"id":{"type":"string"},"leaf":{"type":"boolean"},"name":{"type":"string"},"parent_id":{"type":["string","null"]},"path":{"type":"string"},"site":{"type":"string"}},"type":"object"},"type":"array"},"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"}},"type":"object"},"AutoOfferRule":{"properties":{"discount_pct":{"type":["number","null"]},"enabled":{"type":"boolean"},"exclude_listed_within_days":{"type":["integer","null"]},"id":{"type":["integer","null"]},"interval_minutes":{"type":["integer","null"]},"job":{"enum":["offers_to_likers","favorite_offers","flyp_send_offers","reactivate_inactive","bulk_offer","follow","share"],"type":"string"},"like_lookback_days":{"type":["integer","null"]},"lower_to_pct":{"type":["number","null"]},"marketplace":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"max_per_run":{"type":["integer","null"]},"min_amount_cents":{"description":"Earnings or price floor, in integer cents.","type":["integer","null"]},"min_basis":{"enum":["price","earnings",null],"type":["string","null"]},"shipping_discount_option":{"enum":["none","499","free",null],"type":["string","null"]},"updated_at":{"format":"date-time","type":["string","null"]}},"type":"object"},"PayoutSyncState":{"properties":{"account_id":{"type":"integer"},"job":{"enum":["payouts"],"type":"string"},"paused":{"type":"boolean"},"platform":{"enum":["ebay","poshmark","mercari","vinted","depop"],"type":"string"}},"type":"object"},"AutoOfferList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AutoOffer"},"type":"array"},"stats":{"$ref":"#/components/schemas/AutoOfferStats"}},"type":"object"},"OfferCounter":{"properties":{"amount_cents":{"description":"Integer cents.","type":"integer"},"blocked":{"type":"boolean"},"counter_blocked":{"type":"boolean"},"message":{"type":["string","null"]}},"type":"object"},"AutoOfferMemoryRow":{"properties":{"already_handled":{"type":"boolean"},"external_buyer_id":{"type":"string"},"external_listing_id":{"type":"string"},"fail_count":{"type":"integer"},"last_handled_at":{"format":"date-time","type":"string"},"offer_id":{"type":["integer","null"]},"outcome":{"enum":["offered","skipped","gave_up"],"type":"string"}},"type":"object"},"PayoutUpsert":{"properties":{"amount_cents":{"description":"Payout amount in cents. A clawback may be negative.","type":"integer"},"external_payout_id":{"description":"The site's payout id. Repeating it updates the same row.","type":"string"},"external_status":{"type":["string","null"]},"fee_cents":{"description":"Transfer fee in cents.","type":"integer"},"kind":{"enum":["withdrawal","sale_payout","clawback"],"type":"string"},"method":{"enum":["ach","instant","venmo","paypal","debit_card","other",null],"type":["string","null"]},"paid_at":{"format":"date-time","type":["string","null"]},"platform":{"enum":["ebay","poshmark","mercari","vinted","depop"],"type":"string"},"status":{"enum":["pending","in_transit","paid","failed"],"type":"string"}},"required":["platform","external_payout_id","amount_cents","kind","status"],"type":"object"},"CrosslistImport":{"properties":{"condition":{"type":["string","null"]},"description":{"type":["string","null"]},"external_id":{"description":"The eBay listing id.","type":"string"},"package":{"properties":{"height":{"description":"Alias of height_in.","type":"string"},"height_in":{"type":"string"},"length":{"description":"Alias of length_in.","type":"string"},"length_in":{"type":"string"},"weight":{"description":"Alias of weight_oz.","type":"string"},"weight_oz":{"type":"string"},"width":{"description":"Alias of width_in.","type":"string"},"width_in":{"type":"string"}},"type":"object"},"photos":{"description":"Photo URLs in order. The first is the cover. Objects with url or src are also accepted.","items":{"type":"string"},"type":"array"},"price":{"examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"quantity":{"minimum":0,"type":"integer"},"sku":{"maxLength":100,"type":["string","null"]},"specifics":{"additionalProperties":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"description":"eBay item specifics. A string or a list of strings per name.","type":"object"},"title":{"maxLength":255,"type":"string"}},"type":"object"},"Me":{"properties":{"data":{"properties":{"api_key":{"properties":{"access":{"enum":["read_only","read_write"],"type":"string"},"name":{"type":"string"},"prefix":{"type":"string"}},"type":"object"},"user":{"properties":{"email":{"type":"string"},"id":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"},"PayoutBalanceList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PayoutBalance"},"type":"array"},"owed_cents":{"description":"Sum of owed_cents for accounts that are not paused. Null owed counts as zero.","type":"integer"}},"type":"object"},"StoreSizeWrite":{"properties":{"day":{"format":"date","type":"string"},"qty":{"minimum":0,"type":"integer"}},"type":"object"},"ItemCreate":{"properties":{"acquired_on":{"format":"date","type":["string","null"]},"brand":{"type":["string","null"]},"category":{"type":["string","null"]},"color":{"type":["string","null"]},"condition":{"enum":["new_with_tags","new_without_tags","new","like_new","good","fair","poor","for_parts",null]},"condition_notes":{"description":"Condition details; fills %%CONDITION%% and eBay's condition description.","type":["string","null"]},"cost":{"description":"What you paid (cost of goods).","examples":["45.00"],"type":["string","null"]},"department":{"enum":["women","men","kids","unisex","home","pets","other",null]},"description":{"type":["string","null"]},"height_in":{"description":"Package height, inches.","type":["string","null"]},"length_in":{"description":"Package length, inches.","type":["string","null"]},"listing_template_id":{"description":"The listing template this item uses (see /templates). One per item; a template for one platform only renders there. null for none.","type":["integer","null"]},"notes":{"type":["string","null"]},"original_price":{"description":"Original retail price (MSRP).","examples":["45.00"],"type":["string","null"]},"package_preset_id":{"description":"One of the seller's saved packages (Settings → Lister). weight_oz and the dimensions, when set, override it; with neither, the default package is used.","type":["string","null"]},"photo_urls":{"items":{"type":"string"},"type":"array"},"platform_fields":{"description":"Per-platform extras on top of the shared template. On update, only the platforms and keys you send change; send a key as null or \"\" to clear it. Unknown keys are ignored.","examples":[{"ebay":{"best_offer":true,"material":"Polyester"},"etsy":{"when_made":"2010s","who_made":"Another company or person"}}],"properties":{"depop":{"properties":{"age":{"description":"Age","enum":["Modern","2010s","2000s","1990s","1980s","1970s","1960s","1950s","Older"],"type":"string"},"category":{"description":"Category Required by the platform.","type":"string"},"source":{"description":"Source","enum":["Vintage","Preloved","Deadstock","Handmade"],"type":"string"},"styles":{"description":"Styles Up to 3, e.g. Vintage, Streetwear","items":{"type":"string"},"type":"array"}},"type":"object"},"ebay":{"properties":{"ad_rate":{"description":"Ad rate (%) Promoted Listings General rate, applied once the listing is live. Leave blank for the default.","examples":["7.5"],"type":"string"},"best_offer":{"description":"Accept Best Offer Leave unset to follow the seller's default in Lister settings.","type":"boolean"},"category_id":{"description":"eBay category ID The leaf category number from eBay's category picker. Required by the platform.","type":"string"},"format":{"description":"Format Leave unset to follow the seller's default in Lister settings.","enum":["Buy It Now","Auction"],"type":"string"},"handling_days":{"description":"Handling time Leave unset to follow the seller's default, or the shipping policy's when that's unset too.","enum":["Same day","1 business day","2 business days","3 business days"],"type":"string"},"item_specifics":{"additionalProperties":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"description":"Item specifics eBay's item specifics for the category (US Shoe Size, Model, ...), by name.","examples":[{"Season":["Spring","Fall"],"US Shoe Size":"7.5"}],"type":"object"},"material":{"description":"Material","type":"string"},"offer_auto_accept":{"description":"Auto-accept offers at Offers at or above this are accepted. Leave blank for the default in Lister settings.","examples":["40.00"],"type":"string"},"offer_minimum":{"description":"Decline offers below Offers below this are declined. Leave blank for the default in Lister settings.","examples":["40.00"],"type":"string"},"pattern":{"description":"Pattern","type":"string"},"style":{"description":"Style e.g. Fleece Jacket, Bomber","type":"string"}},"type":"object"},"etsy":{"properties":{"is_supply":{"description":"What is it?","enum":["A finished product","A supply or tool"],"type":"string"},"materials":{"description":"Materials","items":{"type":"string"},"type":"array"},"section":{"description":"Shop section","type":"string"},"when_made":{"description":"When was it made? Vintage on Etsy means at least 20 years old. Required by the platform.","enum":["Made to order","2020s","2010s","2000s","1990s","1980s","1970s","1960s","1950s","Before 1950"],"type":"string"},"who_made":{"description":"Who made it? Required by the platform.","enum":["I did","A member of my shop","Another company or person"],"type":"string"}},"type":"object"},"facebook":{"properties":{"category":{"description":"Category Required by the platform.","type":"string"},"delivery":{"description":"Delivery","enum":["Shipping","Local pickup","Shipping and local pickup"],"type":"string"}},"type":"object"},"mercari":{"properties":{"category":{"description":"Category Required by the platform.","type":"string"},"floor_price":{"description":"Floor price Lowest price Smart Pricing can drop to.","examples":["40.00"],"type":"string"},"shipping_payer":{"description":"Shipping paid by","enum":["Buyer","Seller"],"type":"string"},"smart_pricing":{"description":"Smart Pricing","type":"boolean"}},"type":"object"},"poshmark":{"properties":{"category":{"description":"Category e.g. Jackets & Coats Required by the platform.","type":"string"},"style_tags":{"description":"Style tags Up to 3, e.g. outdoor, cozy","items":{"type":"string"},"type":"array"},"subcategory":{"description":"Subcategory e.g. Fleece","type":"string"}},"type":"object"},"shopify":{"properties":{"collections":{"description":"Collections","items":{"type":"string"},"type":"array"},"product_type":{"description":"Product type","type":"string"},"vendor":{"description":"Vendor Defaults to the brand.","type":"string"}},"type":"object"},"vinted":{"properties":{"category":{"description":"Category Required by the platform.","type":"string"},"material":{"description":"Material","type":"string"},"parcel_size":{"description":"Parcel size","enum":["Small","Medium","Large"],"type":"string"}},"type":"object"}},"type":"object"},"price":{"description":"Asking price. Every listing uses it unless that listing overrides it.","examples":["45.00"],"type":["string","null"]},"quantity":{"default":1,"minimum":0,"type":"integer"},"size":{"type":["string","null"]},"sku":{"description":"Unique per account.","maxLength":100,"type":["string","null"]},"source":{"type":["string","null"]},"status":{"enum":["draft","active","sold","archived"],"type":"string"},"tags":{"description":"Keywords/hashtags. Also accepted as a comma-separated string.","items":{"type":"string"},"maxItems":30,"type":"array"},"title":{"maxLength":255,"type":"string"},"weight_oz":{"description":"Packed weight in ounces.","examples":["18.5"],"type":["string","null"]},"width_in":{"description":"Package width, inches.","type":["string","null"]}},"required":["title"],"type":"object"},"PayoutBalanceUpsert":{"properties":{"available_cents":{"description":"Available to withdraw, in cents.","type":"integer"},"captured_at":{"format":"date-time","type":"string"},"currency":{"examples":["USD"],"maxLength":3,"minLength":3,"type":"string"},"owed_cents":{"description":"Owed amount to store, in cents. Not derived from pending.","type":"integer"},"pending_cents":{"description":"Pending marketplace balance, in cents.","type":"integer"},"total_cents":{"description":"Total balance, in cents.","type":"integer"}},"required":["currency","available_cents","pending_cents","owed_cents","total_cents","captured_at"],"type":"object"},"ListingTemplate":{"properties":{"description_template":{"type":["string","null"]},"fields":{"items":{"properties":{"default":{"description":"May contain placeholders.","type":["string","null"]},"help":{"type":["string","null"]},"internal":{"description":"Drives rules only; not an item specific.","type":"boolean"},"key":{"type":"string"},"label":{"type":"string"},"options":{"items":{"type":"string"},"type":"array"},"required":{"type":"boolean"},"type":{"enum":["text","select","multiselect","boolean"],"type":"string"}},"type":"object"},"type":"array"},"id":{"type":"integer"},"name":{"type":"string"},"platform":{"description":"Platform slug, or \"all\" for a template usable on every platform.","examples":["ebay","all"],"type":"string"},"rules":{"items":{"properties":{"field":{"type":"string"},"label":{"type":["string","null"]},"value":{"type":["string","null"]},"when_field":{"type":"string"},"when_value":{"type":"string"}},"type":"object"},"type":"array"},"title_template":{"examples":["%%TITLE%%"],"type":["string","null"]},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"WorkerRun":{"properties":{"details":{"type":["object","null"]},"device_id":{"type":["integer","null"]},"done":{"type":["integer","null"]},"error":{"type":["string","null"]},"failed_count":{"type":["integer","null"]},"finished_at":{"format":"date-time","type":["string","null"]},"id":{"type":"integer"},"job":{"enum":["offers_to_likers","favorite_offers","flyp_send_offers","bulk_offer","follow","share","reactivate_inactive","offers_inbox","offer_history","chat_offers","posh_newsfeed_likes","posh_listing_sweep","depop_likes","post_listings","sync_listings","price_drop","fix_check","sold_check","cross_check","mark_sold","sales","profit","payouts","to_ship","store_size"],"type":"string"},"marketplace_account_id":{"type":["integer","null"]},"mode":{"enum":[null,"full","quick"],"type":["string","null"]},"people_count":{"type":["integer","null"]},"sent_count":{"type":["integer","null"]},"skipped":{"type":["object","null"]},"started_at":{"format":"date-time","type":"string"},"status":{"enum":["running","succeeded","problem","failed","stopped","timed_out"],"type":"string"},"summary":{"type":["string","null"]},"total":{"type":["integer","null"]},"trigger":{"enum":["scheduled","manual","turned_on","job"],"type":"string"}},"type":"object"},"AutoOfferMemory":{"properties":{"listings":{"items":{"$ref":"#/components/schemas/AutoOfferListingState"},"type":"array"},"marketplace":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"memory":{"items":{"$ref":"#/components/schemas/AutoOfferMemoryRow"},"type":"array"}},"type":"object"},"PriceDropStep":{"properties":{"at":{"format":"date-time","type":["string","null"]},"base_price_cents":{"description":"Integer cents.","type":["integer","null"]},"error":{"type":["string","null"]},"item_id":{"type":"integer"},"listing_id":{"type":"integer"},"marketplace_id":{"type":"integer"},"status":{"enum":["started","done","failed","locked"],"type":"string"},"step":{"enum":["price","relist","delist"],"type":"string"},"target_price_cents":{"description":"Integer cents.","type":["integer","null"]}},"type":"object"},"CrosslistTask":{"properties":{"action":{"enum":["publish","update","end"],"type":"string"},"id":{"type":"integer"},"listing_id":{"type":"integer"},"status":{"examples":["pending"],"type":"string"}},"type":"object"},"Platform":{"properties":{"color":{"type":["string","null"]},"name":{"type":"string"},"slug":{"type":"string"}},"type":"object"},"OfferDecline":{"properties":{"message":{"type":["string","null"]}},"type":"object"},"PriceDropRule":{"properties":{"batch_size":{"type":"integer"},"enabled":{"type":"boolean"},"id":{"type":["integer","null"]},"min_active_listings":{"type":"integer"},"min_days_since_change":{"type":"integer"},"min_last_change_on":{"format":"date","type":["string","null"]},"min_price_cents":{"type":"integer"},"pct":{"description":"Percent from 1 to 90.","examples":["20.00"],"type":"string"},"relist_marketplace_ids":{"items":{"type":"integer"},"type":"array"},"respect_floor_price":{"type":"boolean"},"rounding":{"enum":["x99","whole","none"],"type":"string"}},"type":"object"},"ToShipOrder":{"properties":{"external_order_id":{"description":"The platform's order id. Repeating it updates the same sale.","type":"string"},"sku":{"type":["string","null"]},"title":{"type":["string","null"]},"url":{"type":["string","null"]}},"required":["external_order_id"],"type":"object"},"WorkerDeviceCreated":{"properties":{"id":{"type":"integer"},"token":{"description":"Shown once. Send it later as `X-Device-Token`.","type":"string"}},"required":["id","token"],"type":"object"},"AutoOfferAttempt":{"properties":{"account_id":{"type":"integer"},"amount_cents":{"description":"Tried amount in integer cents.","type":"integer"},"buyer_external_id":{"type":["string","null"]},"external_listing_id":{"type":["string","null"]},"listing_price_cents":{"description":"Listing price in integer cents.","type":"integer"},"offer_id":{"type":["integer","null"]},"outcome":{"enum":["sent","unconfirmed","not_sent","refused","failed","skipped"],"type":"string"},"reason":{"type":["string","null"]},"run_id":{"type":["integer","null"]}},"required":["account_id","outcome"],"type":"object"},"ToShipPlatform":{"properties":{"captured_at":{"description":"When the last successful read finished.","format":"date-time","type":["string","null"]},"count":{"description":"Orders waiting on this platform. Null when it has not been read successfully.","minimum":0,"type":["integer","null"]},"error":{"description":"Set when the last read of this platform failed.","type":["string","null"]},"platform":{"enum":["poshmark","ebay","depop","mercari","vinted","facebook"],"type":"string"}},"type":"object"},"WorkerLease":{"properties":{"device_id":{"type":"integer"},"lease_until":{"format":"date-time","type":"string"},"marketplace_account_id":{"type":"integer"}},"type":"object"},"RenderedListing":{"properties":{"category":{"type":["string","null"]},"condition":{"description":"In the platform's own wording.","type":["string","null"]},"condition_description":{"type":["string","null"]},"custom_label":{"type":["string","null"]},"description":{"type":["string","null"]},"item_specifics":{"additionalProperties":{"type":"string"},"type":"object"},"original_price":{"examples":["45.00"],"type":["string","null"]},"package":{"properties":{"defaulted":{"description":"True when seller defaults filled in.","type":"boolean"},"dimensions":{"examples":["15 × 11 × 6 in"],"type":["string","null"]},"height_in":{"type":["string","null"]},"length_in":{"type":["string","null"]},"weight":{"examples":["1 lb 15 oz"],"type":["string","null"]},"weight_oz":{"type":["string","null"]},"width_in":{"type":["string","null"]}},"type":"object"},"photos":{"items":{"type":"string"},"type":"array"},"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"platform_fields":{"type":"object"},"policies":{"additionalProperties":{"type":"string"},"type":"object"},"price":{"examples":["45.00"],"type":["string","null"]},"ready":{"type":"boolean"},"store_category":{"type":["string","null"]},"tags":{"items":{"type":"string"},"type":"array"},"template":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":["object","null"]},"title":{"type":["string","null"]},"warnings":{"items":{"type":"string"},"type":"array"}},"type":"object"},"ListingCreate":{"properties":{"external_id":{"description":"The platform's listing id.","type":"string"},"listed_at":{"format":"date-time","type":"string"},"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"price":{"description":"This platform's price, only if it differs from the item's. Omit to use the item price; null clears an override. Matching the item price is treated as no override.","examples":["45.00"],"type":["string","null"]},"url":{"format":"uri","type":"string"}},"required":["platform"],"type":"object"},"SaleRecorded":{"properties":{"already_recorded":{"description":"True when `external_order_id` was already recorded; `data` is the existing sale and nothing changed.","type":"boolean"},"data":{"$ref":"#/components/schemas/Sale"},"item":{"properties":{"id":{"type":"integer"},"quantity":{"type":"integer"},"status":{"enum":["draft","active","sold","archived"],"type":"string"}},"type":"object"},"needs_delist":{"description":"Listings to take down because the item sold out.","items":{"$ref":"#/components/schemas/Listing"},"type":"array"}},"type":"object"},"ListingIssueCreate":{"properties":{"external_listing_id":{"type":["string","null"]},"item_id":{"type":["integer","null"]},"kind":{"enum":["sold_live_elsewhere","stale_link","not_in_inventory","duplicate_sku","dead","partial","sold_not_recorded","relisted_where_sold"],"type":"string"},"listing_id":{"type":["integer","null"]},"sku_text":{"type":["string","null"]}},"type":"object"},"StoreSize":{"properties":{"day":{"format":"date","type":"string"},"qty":{"type":"integer"}},"type":"object"},"Listing":{"properties":{"delisted_at":{"format":"date-time","type":["string","null"]},"external_id":{"type":["string","null"]},"id":{"type":"integer"},"item":{"properties":{"id":{"type":"integer"},"quantity":{"type":"integer"},"sku":{"type":["string","null"]},"title":{"type":"string"}},"type":"object"},"item_id":{"type":"integer"},"listed_at":{"format":"date-time","type":["string","null"]},"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"price":{"description":"Effective price: the override, or the item's price.","examples":["45.00"],"type":["string","null"]},"price_overridden":{"description":"True when this listing's price differs from the item's.","type":"boolean"},"status":{"enum":["active","needs_delist","delisted","sold"],"type":"string"},"updated_at":{"format":"date-time","type":"string"},"url":{"type":["string","null"]}},"type":"object"},"PriceDropPlanItemPatch":{"properties":{"include":{"type":"boolean"},"pct":{"description":"Percent from 1 to 90.","examples":["20.00"],"type":"string"}},"type":"object"},"AutoOfferListingState":{"properties":{"baseline_only":{"type":"boolean"},"external_listing_id":{"type":"string"},"last_offer_at":{"format":"date-time","type":["string","null"]},"last_offer_cents":{"type":["integer","null"]},"likes_at_last_offer":{"type":["integer","null"]},"lowest_offer_cents":{"type":["integer","null"]},"marketplace_last_otl_cents":{"type":["integer","null"]}},"type":"object"},"WorkerDevice":{"properties":{"id":{"type":"integer"},"last_seen_at":{"format":"date-time","type":["string","null"]},"name":{"type":["string","null"]},"signed_in":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object"},"version":{"type":["string","null"]}},"type":"object"},"ToShipItem":{"properties":{"item_id":{"description":"Null when the SKU matches no item.","type":["integer","null"]},"platform":{"enum":["poshmark","ebay","depop","mercari","vinted","facebook"],"type":"string"},"sku":{"type":["string","null"]},"title":{"type":["string","null"]},"url":{"type":["string","null"]}},"type":"object"},"AutoOfferRecipientInput":{"properties":{"external_user_id":{"type":"string"},"outcome":{"enum":["received","skipped_by_marketplace","unknown"],"type":"string"},"username":{"type":"string"}},"type":"object"},"OfferInboxOffer":{"properties":{"amount_cents":{"description":"Integer cents.","type":"integer"},"counter_max_cents":{"type":["integer","null"]},"counter_min_cents":{"type":["integer","null"]},"currency":{"type":"string"},"external_offer_id":{"type":"string"},"initiated_by":{"enum":["buyer","seller"],"type":"string"},"kind":{"enum":["buyer_offer","counter","offer_to_likers","private_offer"],"type":"string"},"listing_price_cents":{"description":"Integer cents.","type":"integer"},"message":{"type":["string","null"]},"status":{"enum":["pending","accepted","declined","countered","expired","cancelled"],"type":"string"}},"type":"object"},"Payout":{"properties":{"account_id":{"type":"integer"},"amount_cents":{"description":"Payout amount in cents. Negative only when kind is clawback.","type":"integer"},"currency":{"maxLength":3,"minLength":3,"type":"string"},"external_payout_id":{"type":"string"},"external_status":{"type":["string","null"]},"fee_cents":{"description":"Transfer fee in cents. Zero when the site charges none.","type":"integer"},"id":{"type":"integer"},"kind":{"enum":["withdrawal","sale_payout","clawback"],"type":"string"},"method":{"enum":["ach","instant","venmo","paypal","debit_card","other",null],"type":["string","null"]},"paid_at":{"format":"date-time","type":["string","null"]},"platform":{"enum":["ebay","poshmark","mercari","vinted","depop"],"type":"string"},"status":{"enum":["pending","in_transit","paid","failed"],"type":"string"}},"type":"object"},"ListingIssue":{"properties":{"detected_at":{"format":"date-time","type":["string","null"]},"external_listing_id":{"type":["string","null"]},"id":{"type":"integer"},"item_id":{"type":["integer","null"]},"kind":{"enum":["sold_live_elsewhere","stale_link","not_in_inventory","duplicate_sku","dead","partial","sold_not_recorded","relisted_where_sold"],"type":"string"},"listing_id":{"type":["integer","null"]},"resolution":{"type":["string","null"]},"resolved_at":{"format":"date-time","type":["string","null"]},"sku_text":{"type":["string","null"]}},"type":"object"},"ListingUpserted":{"properties":{"created":{"type":"boolean"},"data":{"$ref":"#/components/schemas/Listing"}},"type":"object"},"ListingSummary":{"properties":{"delisted_at":{"format":"date-time","type":["string","null"]},"external_id":{"type":["string","null"]},"id":{"type":"integer"},"item_id":{"type":"integer"},"listed_at":{"format":"date-time","type":["string","null"]},"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"price":{"description":"Effective price: the override, or the item's price.","examples":["45.00"],"type":["string","null"]},"price_overridden":{"description":"True when this listing's price differs from the item's.","type":"boolean"},"status":{"enum":["active","needs_delist","delisted","sold"],"type":"string"},"updated_at":{"format":"date-time","type":"string"},"url":{"type":["string","null"]}},"type":"object"},"AutoOfferRecipient":{"properties":{"external_user_id":{"type":"string"},"outcome":{"enum":["received","skipped_by_marketplace","unknown"],"type":"string"},"username":{"type":["string","null"]}},"type":"object"},"CrosslistView":{"properties":{"brand":{"type":["string","null"]},"condition":{"type":["string","null"]},"created":{"description":"Present on import. True when this call created the item.","type":"boolean"},"description":{"type":["string","null"]},"id":{"type":"integer"},"package":{"properties":{"height_in":{"type":["string","null"]},"length_in":{"type":["string","null"]},"weight_oz":{"type":["string","null"]},"width_in":{"type":["string","null"]}},"type":"object"},"photos":{"items":{"properties":{"id":{"type":"integer"},"position":{"type":"integer"},"url":{"type":"string"}},"type":"object"},"type":"array"},"price":{"examples":["45.00"],"type":["string","null"]},"quantity":{"type":"integer"},"sites":{"additionalProperties":{"type":["object","null"]},"description":"One key per marketplace. Null when the item is not listed there.","type":"object"},"sku":{"type":["string","null"]},"title":{"type":["string","null"]}},"type":"object"},"Conversation":{"properties":{"awaiting_reply":{"type":"boolean"},"detected_at":{"format":"date-time","type":["string","null"]},"detected_offer_cents":{"type":["integer","null"]},"detected_offer_text":{"maxLength":140,"type":["string","null"]},"external_listing_id":{"type":["string","null"]},"external_thread_id":{"type":"string"},"id":{"type":"integer"},"platform":{"type":["string","null"]}},"type":"object"},"ConversationUpsert":{"properties":{"awaiting_reply":{"type":"boolean"},"detected_offer_cents":{"type":["integer","null"]},"detected_offer_text":{"description":"The detected price in the buyer's words. 140 characters or fewer.","maxLength":140,"type":["string","null"]},"external_thread_id":{"type":"string"},"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"}},"required":["external_thread_id","platform"],"type":"object"},"SyncListingUpsert":{"properties":{"item":{"$ref":"#/components/schemas/ItemCreate","description":"Creates the item if no `item_id`/`sku` match."},"item_id":{"description":"Item to list (when creating).","type":"integer"},"listed_at":{"format":"date-time","type":"string"},"price":{"description":"This platform's price, only if it differs from the item's. Omit to use the item price; null clears an override. Matching the item price is treated as no override.","examples":["45.00"],"type":["string","null"]},"sku":{"description":"Find the item by SKU (when creating).","type":"string"},"status":{"enum":["active","needs_delist","delisted","sold"],"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"SaleProfitNeeded":{"properties":{"external_order_id":{"type":["string","null"]},"id":{"type":"integer"},"platform":{"type":["string","null"]},"reported_payout_cents":{"description":"Integer cents.","type":["integer","null"]},"sold_at":{"format":"date-time","type":"string"},"status":{"type":"string"}},"type":"object"},"Offer":{"properties":{"amount_cents":{"description":"Integer cents.","type":"integer"},"counter_blocked_until":{"format":"date-time","type":["string","null"]},"counter_max_cents":{"type":["integer","null"]},"counter_min_cents":{"type":["integer","null"]},"currency":{"type":["string","null"]},"decided_by":{"enum":["seller","buyer","rule","marketplace",null],"type":["string","null"]},"expires_at":{"format":"date-time","type":["string","null"]},"external_listing_id":{"type":["string","null"]},"external_offer_id":{"type":["string","null"]},"external_thread_id":{"type":["string","null"]},"follow_until":{"format":"date-time","type":["string","null"]},"id":{"type":"integer"},"initiated_by":{"enum":["buyer","seller"],"type":"string"},"inserted_at":{"format":"date-time","type":"string"},"kind":{"enum":["buyer_offer","counter","offer_to_likers","private_offer"],"type":"string"},"listing_id":{"type":["integer","null"]},"listing_price_cents":{"description":"Integer cents.","type":"integer"},"listing_title":{"type":["string","null"]},"message":{"type":["string","null"]},"offered_at":{"format":"date-time","type":["string","null"]},"parent_offer_id":{"type":["integer","null"]},"platform":{"type":["string","null"]},"quantity":{"type":"integer"},"responded_at":{"format":"date-time","type":["string","null"]},"seller_earnings_cents":{"type":["integer","null"]},"seller_shipping_cost_cents":{"type":["integer","null"]},"shipping_discount_cents":{"description":"Integer cents.","type":"integer"},"status":{"enum":["pending","accepted","declined","countered","expired","cancelled"],"type":"string"},"thread_id":{"type":["integer","null"]}},"type":"object"},"SaleProfitWrite":{"properties":{"earnings_cents":{"description":"Stored as reported_payout_cents.","type":"integer"},"reported_payout_cents":{"type":"integer"}},"type":"object"},"OfferThread":{"properties":{"counter_blocked_reason":{"type":["string","null"]},"counter_blocked_until":{"format":"date-time","type":["string","null"]},"external_listing_id":{"type":["string","null"]},"external_thread_id":{"type":"string"},"first_seen_at":{"format":"date-time","type":"string"},"follow_until":{"format":"date-time","type":["string","null"]},"history_partial":{"type":"boolean"},"id":{"type":"integer"},"last_seen_at":{"format":"date-time","type":"string"},"listing_id":{"type":["integer","null"]},"platform":{"type":["string","null"]},"status":{"type":["string","null"]}},"type":"object"},"WorkerSchedule":{"properties":{"daily_at":{"examples":["09:15:00"],"format":"time","type":["string","null"]},"enabled":{"type":"boolean"},"id":{"type":"integer"},"interval_minutes":{"type":["integer","null"]},"job":{"enum":["offers_to_likers","favorite_offers","flyp_send_offers","bulk_offer","follow","share","reactivate_inactive","offers_inbox","offer_history","chat_offers","posh_newsfeed_likes","posh_listing_sweep","depop_likes","post_listings","sync_listings","price_drop","fix_check","sold_check","cross_check","mark_sold","sales","profit","payouts","to_ship","store_size"],"type":"string"},"marketplace_account_id":{"type":["integer","null"]},"next_run_at":{"format":"date-time","type":["string","null"]}},"type":"object"},"AutoOfferRun":{"properties":{"account_id":{"type":"integer"},"details":{"type":"object"},"job":{"enum":["offers_to_likers","favorite_offers","flyp_send_offers","reactivate_inactive","bulk_offer","follow","share"],"type":"string"},"people_count":{"minimum":0,"type":"integer"},"sent_count":{"minimum":0,"type":"integer"},"status":{"enum":["running","succeeded","problem","failed","stopped","timed_out"],"type":"string"},"summary":{"type":["string","null"]},"trigger":{"enum":["scheduled","manual","turned_on","job"],"type":"string"}},"required":["account_id","job","status"],"type":"object"},"PriceDropPlanItem":{"properties":{"base_list_price_cents":{"description":"Integer cents.","type":["integer","null"]},"include":{"type":"boolean"},"item_id":{"type":"integer"},"pct":{"description":"Percent from 1 to 90.","examples":["20.00"],"type":"string"},"position":{"type":"integer"},"status":{"enum":["pending","running","done","failed","ended","skipped"],"type":"string"},"target_list_price_cents":{"description":"Integer cents.","type":["integer","null"]}},"type":"object"},"PriceDropProgress":{"properties":{"base":{"type":"object"},"ended_at":{"format":"date-time","type":["string","null"]},"item_id":{"type":"integer"},"pct":{"description":"Percent from 1 to 90.","examples":["20.00"],"type":"string"},"started_at":{"format":"date-time","type":["string","null"]},"steps":{"items":{"$ref":"#/components/schemas/PriceDropStep"},"type":"array"},"universal_price_cents":{"description":"Integer cents.","type":["integer","null"]}},"type":"object"},"WorkerSyncState":{"properties":{"backfilled":{"type":"boolean"},"blocked_until":{"format":"date-time","type":["string","null"]},"cursor":{"type":"object"},"items_scanned":{"type":["integer","null"]},"job":{"enum":["offers_to_likers","favorite_offers","flyp_send_offers","bulk_offer","follow","share","reactivate_inactive","offers_inbox","offer_history","chat_offers","posh_newsfeed_likes","posh_listing_sweep","depop_likes","post_listings","sync_listings","price_drop","fix_check","sold_check","cross_check","mark_sold","sales","profit","payouts","to_ship","store_size"],"type":"string"},"last_attempt_at":{"format":"date-time","type":["string","null"]},"last_error":{"type":["string","null"]},"last_full_at":{"format":"date-time","type":["string","null"]},"last_success_at":{"format":"date-time","type":["string","null"]},"marketplace_account_id":{"type":"integer"},"marketplace_id":{"type":"integer"},"paused":{"type":"boolean"},"progress_note":{"type":["string","null"]},"schema_version":{"type":"integer"},"watermark_at":{"format":"date-time","type":["string","null"]}},"type":"object"},"Sale":{"properties":{"buyer":{"type":["string","null"]},"external_order_id":{"type":["string","null"]},"id":{"type":"integer"},"inserted_at":{"format":"date-time","type":"string"},"item":{"properties":{"id":{"type":"integer"},"sku":{"type":["string","null"]},"title":{"type":"string"}},"type":"object"},"item_id":{"type":"integer"},"listing_id":{"type":["integer","null"]},"notes":{"type":["string","null"]},"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"platform_fees":{"description":"Total fees the platform took.","examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"quantity":{"minimum":1,"type":"integer"},"sale_price":{"examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"shipping_charged":{"description":"Shipping the buyer paid.","examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"shipping_cost":{"description":"What you paid for postage.","examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"sold_at":{"format":"date-time","type":"string"},"unit_cost":{"description":"Item cost at the time of sale.","examples":["45.00"],"type":["string","null"]}},"type":"object"},"SaleProfit":{"properties":{"earnings_cents":{"description":"Integer cents.","type":["integer","null"]},"id":{"type":"integer"},"money_final_at":{"format":"date-time","type":["string","null"]},"money_synced_at":{"format":"date-time","type":["string","null"]},"reported_payout_cents":{"description":"Integer cents.","type":["integer","null"]}},"type":"object"},"PriceDropRuleWrite":{"properties":{"batch_size":{"minimum":1,"type":"integer"},"enabled":{"type":"boolean"},"min_active_listings":{"minimum":1,"type":"integer"},"min_days_since_change":{"minimum":0,"type":"integer"},"min_last_change_on":{"description":"Only items changed on or after this date. Null clears it.","format":"date","type":["string","null"]},"min_price_cents":{"minimum":0,"type":"integer"},"pct":{"description":"Percent from 1 to 90.","examples":["20.00"],"type":"string"},"relist_marketplace_ids":{"items":{"type":"integer"},"type":"array"},"respect_floor_price":{"type":"boolean"},"rounding":{"enum":["x99","whole","none"],"type":"string"}},"type":"object"},"WorkerClaim":{"properties":{"account_tasks":{"items":{"$ref":"#/components/schemas/WorkerTask"},"type":"array"},"listing_tasks":{"items":{"$ref":"#/components/schemas/WorkerTask"},"type":"array"}},"type":"object"},"OfferInbox":{"properties":{"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"threads":{"items":{"$ref":"#/components/schemas/OfferInboxThread"},"type":"array"}},"required":["platform","threads"],"type":"object"},"StockAdjustment":{"properties":{"change":{"description":"Units to add (+) or remove (-).","not":{"const":0},"type":"integer"},"note":{"type":"string"},"reason":{"default":"adjustment","enum":["adjustment","return"],"type":"string"}},"required":["change"],"type":"object"},"StockMovement":{"properties":{"change":{"type":"integer"},"id":{"type":"integer"},"inserted_at":{"format":"date-time","type":"string"},"note":{"type":["string","null"]},"reason":{"enum":["initial","sale","adjustment","return","void"],"type":"string"},"sale_id":{"type":["integer","null"]}},"type":"object"},"Item":{"properties":{"source":{"type":["string","null"]},"condition_notes":{"description":"Condition details; fills %%CONDITION%% and eBay's condition description.","type":["string","null"]},"notes":{"type":["string","null"]},"condition":{"enum":["new_with_tags","new_without_tags","new","like_new","good","fair","poor","for_parts",null]},"ready_to_list":{"description":"True when the template has everything platforms need (see missing_for_listing).","type":"boolean"},"category":{"type":["string","null"]},"updated_at":{"format":"date-time","type":"string"},"inserted_at":{"format":"date-time","type":"string"},"price":{"description":"Asking price. Every listing uses it unless that listing overrides it.","examples":["45.00"],"type":["string","null"]},"cost":{"description":"What you paid (cost of goods).","examples":["45.00"],"type":["string","null"]},"department":{"enum":["women","men","kids","unisex","home","pets","other",null]},"width_in":{"description":"Package width, inches.","type":["string","null"]},"description":{"type":["string","null"]},"size":{"type":["string","null"]},"sku":{"description":"Unique per account.","maxLength":100,"type":["string","null"]},"tags":{"description":"Keywords/hashtags. Also accepted as a comma-separated string.","items":{"type":"string"},"maxItems":30,"type":"array"},"status":{"enum":["draft","active","sold","archived"],"type":"string"},"height_in":{"description":"Package height, inches.","type":["string","null"]},"weight_oz":{"description":"Packed weight in ounces.","examples":["18.5"],"type":["string","null"]},"color":{"type":["string","null"]},"length_in":{"description":"Package length, inches.","type":["string","null"]},"platform_fields":{"description":"Per-platform extras on top of the shared template. On update, only the platforms and keys you send change; send a key as null or \"\" to clear it. Unknown keys are ignored.","examples":[{"ebay":{"best_offer":true,"material":"Polyester"},"etsy":{"when_made":"2010s","who_made":"Another company or person"}}],"properties":{"depop":{"properties":{"age":{"description":"Age","enum":["Modern","2010s","2000s","1990s","1980s","1970s","1960s","1950s","Older"],"type":"string"},"category":{"description":"Category Required by the platform.","type":"string"},"source":{"description":"Source","enum":["Vintage","Preloved","Deadstock","Handmade"],"type":"string"},"styles":{"description":"Styles Up to 3, e.g. Vintage, Streetwear","items":{"type":"string"},"type":"array"}},"type":"object"},"ebay":{"properties":{"ad_rate":{"description":"Ad rate (%) Promoted Listings General rate, applied once the listing is live. Leave blank for the default.","examples":["7.5"],"type":"string"},"best_offer":{"description":"Accept Best Offer Leave unset to follow the seller's default in Lister settings.","type":"boolean"},"category_id":{"description":"eBay category ID The leaf category number from eBay's category picker. Required by the platform.","type":"string"},"format":{"description":"Format Leave unset to follow the seller's default in Lister settings.","enum":["Buy It Now","Auction"],"type":"string"},"handling_days":{"description":"Handling time Leave unset to follow the seller's default, or the shipping policy's when that's unset too.","enum":["Same day","1 business day","2 business days","3 business days"],"type":"string"},"item_specifics":{"additionalProperties":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"description":"Item specifics eBay's item specifics for the category (US Shoe Size, Model, ...), by name.","examples":[{"Season":["Spring","Fall"],"US Shoe Size":"7.5"}],"type":"object"},"material":{"description":"Material","type":"string"},"offer_auto_accept":{"description":"Auto-accept offers at Offers at or above this are accepted. Leave blank for the default in Lister settings.","examples":["40.00"],"type":"string"},"offer_minimum":{"description":"Decline offers below Offers below this are declined. Leave blank for the default in Lister settings.","examples":["40.00"],"type":"string"},"pattern":{"description":"Pattern","type":"string"},"style":{"description":"Style e.g. Fleece Jacket, Bomber","type":"string"}},"type":"object"},"etsy":{"properties":{"is_supply":{"description":"What is it?","enum":["A finished product","A supply or tool"],"type":"string"},"materials":{"description":"Materials","items":{"type":"string"},"type":"array"},"section":{"description":"Shop section","type":"string"},"when_made":{"description":"When was it made? Vintage on Etsy means at least 20 years old. Required by the platform.","enum":["Made to order","2020s","2010s","2000s","1990s","1980s","1970s","1960s","1950s","Before 1950"],"type":"string"},"who_made":{"description":"Who made it? Required by the platform.","enum":["I did","A member of my shop","Another company or person"],"type":"string"}},"type":"object"},"facebook":{"properties":{"category":{"description":"Category Required by the platform.","type":"string"},"delivery":{"description":"Delivery","enum":["Shipping","Local pickup","Shipping and local pickup"],"type":"string"}},"type":"object"},"mercari":{"properties":{"category":{"description":"Category Required by the platform.","type":"string"},"floor_price":{"description":"Floor price Lowest price Smart Pricing can drop to.","examples":["40.00"],"type":"string"},"shipping_payer":{"description":"Shipping paid by","enum":["Buyer","Seller"],"type":"string"},"smart_pricing":{"description":"Smart Pricing","type":"boolean"}},"type":"object"},"poshmark":{"properties":{"category":{"description":"Category e.g. Jackets & Coats Required by the platform.","type":"string"},"style_tags":{"description":"Style tags Up to 3, e.g. outdoor, cozy","items":{"type":"string"},"type":"array"},"subcategory":{"description":"Subcategory e.g. Fleece","type":"string"}},"type":"object"},"shopify":{"properties":{"collections":{"description":"Collections","items":{"type":"string"},"type":"array"},"product_type":{"description":"Product type","type":"string"},"vendor":{"description":"Vendor Defaults to the brand.","type":"string"}},"type":"object"},"vinted":{"properties":{"category":{"description":"Category Required by the platform.","type":"string"},"material":{"description":"Material","type":"string"},"parcel_size":{"description":"Parcel size","enum":["Small","Medium","Large"],"type":"string"}},"type":"object"}},"type":"object"},"photo_urls":{"items":{"type":"string"},"type":"array"},"acquired_on":{"format":"date","type":["string","null"]},"missing_for_listing":{"description":"Required template fields still empty.","items":{"enum":["title","price","photos","condition","description"],"type":"string"},"type":"array"},"original_price":{"description":"Original retail price (MSRP).","examples":["45.00"],"type":["string","null"]},"quantity":{"minimum":0,"type":"integer"},"listing_template_id":{"description":"The listing template this item uses (see /templates). One per item; a template for one platform only renders there. null for none.","type":["integer","null"]},"brand":{"type":["string","null"]},"id":{"type":"integer"},"title":{"maxLength":255,"type":"string"},"package_preset_id":{"description":"One of the seller's saved packages (Settings → Lister). weight_oz and the dimensions, when set, override it; with neither, the default package is used.","type":["string","null"]},"listings":{"items":{"$ref":"#/components/schemas/ListingSummary"},"type":"array"}},"type":"object"},"PayoutBalance":{"properties":{"account_id":{"type":"integer"},"available_cents":{"description":"Available to withdraw, in cents.","type":"integer"},"captured_at":{"format":"date-time","type":"string"},"currency":{"maxLength":3,"minLength":3,"type":"string"},"owed_cents":{"description":"Amount counted toward the desk total, in cents, as sent by the client.","type":"integer"},"paused":{"description":"True when payout sync is paused for this account.","type":"boolean"},"pending_cents":{"description":"Pending marketplace balance, in cents. Stored, not added into owed.","type":"integer"},"platform":{"enum":["ebay","poshmark","mercari","vinted","depop"],"type":"string"},"total_cents":{"description":"Total balance, in cents.","type":"integer"}},"type":"object"},"AutoOfferSend":{"properties":{"account_id":{"type":"integer"},"amount_cents":{"description":"Offer amount in integer cents.","type":"integer"},"kind":{"enum":["offer_to_likers","private_offer"],"type":"string"},"listing":{"$ref":"#/components/schemas/AutoOfferListing"},"recipients":{"items":{"$ref":"#/components/schemas/AutoOfferRecipientInput"},"type":"array"},"run_id":{"type":["integer","null"]},"verified_at":{"format":"date-time","type":["string","null"]},"via":{"enum":["direct","flyp","ui_automation","bulk_tool","offer_desk","marketplace_app"],"type":"string"}},"required":["account_id","kind","amount_cents","listing"],"type":"object"},"ToShipList":{"properties":{"count":{"description":"Sum of platform counts that are numbers. A null count is left out, not added as zero.","minimum":0,"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/ToShipItem"},"type":"array"},"platforms":{"items":{"$ref":"#/components/schemas/ToShipPlatform"},"type":"array"}},"type":"object"},"AutoOfferMarketplaceStats":{"properties":{"items":{"type":"integer"},"people":{"type":"integer"}},"type":"object"},"SaleCreate":{"description":"Provide `platform` or `listing_id`.","properties":{"buyer":{"type":"string"},"external_order_id":{"description":"Unique per platform; duplicates are rejected.","type":"string"},"listing_id":{"type":"integer"},"notes":{"type":"string"},"platform":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"platform_fees":{"description":"Total fees the platform took.","examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"quantity":{"default":1,"minimum":1,"type":"integer"},"sale_price":{"examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"shipping_charged":{"description":"Shipping the buyer paid.","examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"shipping_cost":{"description":"What you paid for postage.","examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"sold_at":{"description":"Defaults to now.","format":"date-time","type":"string"}},"required":["sale_price"],"type":"object"},"Summary":{"properties":{"cost_of_goods":{"examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"net_profit":{"examples":["24.50","-3.00"],"type":"string"},"platform_fees":{"examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"revenue":{"examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"sales":{"type":"integer"},"sales_missing_cost":{"description":"Sales of items with no recorded cost (counted as zero cost).","type":"integer"},"shipping_charged":{"examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"shipping_cost":{"examples":["45.00"],"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string"},"units":{"type":"integer"}},"type":"object"},"AutoOfferRuleWrite":{"properties":{"discount_pct":{"maximum":90,"minimum":1,"type":"number"},"enabled":{"type":"boolean"},"exclude_listed_within_days":{"maximum":365,"minimum":0,"type":"integer"},"interval_minutes":{"maximum":10080,"minimum":2,"type":"integer"},"like_lookback_days":{"maximum":90,"minimum":1,"type":"integer"},"lower_to_pct":{"maximum":70,"minimum":0,"type":"number"},"max_per_run":{"minimum":1,"type":"integer"},"min_amount_cents":{"description":"Floor in integer cents.","type":"integer"},"min_basis":{"enum":["price","earnings"],"type":"string"},"shipping_discount_option":{"enum":["none","499","free"],"type":"string"}},"required":["enabled"],"type":"object"},"PriceDropPlan":{"properties":{"built_at":{"format":"date-time","type":"string"},"edited_per_item":{"type":"boolean"},"id":{"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/PriceDropPlanItem"},"type":"array"},"matching_count":{"type":"integer"},"started_at":{"format":"date-time","type":["string","null"]},"status":{"enum":["draft","running","finished","stopped"],"type":"string"},"steps":{"items":{"$ref":"#/components/schemas/PriceDropStep"},"type":"array"},"total_listed":{"type":["integer","null"]}},"type":"object"},"WorkerRate":{"properties":{"action":{"enum":["follow","offer","post","share"],"type":"string"},"day":{"format":"date","type":"string"},"marketplace_account_id":{"type":"integer"},"n":{"minimum":0,"type":"integer"}},"type":"object"}},"securitySchemes":{"bearerAuth":{"bearerFormat":"btb_...","scheme":"bearer","type":"http"}}},"info":{"description":"Track inventory, listings and sales across reselling platforms.\n\nAuthenticate with `Authorization: Bearer <api key>` (create keys in Settings → API keys).\nRead-only keys can call GET endpoints only. Money is a decimal string (`\"45.00\"`),\ntimes are ISO 8601 UTC, platforms are referenced by slug.\n\nErrors always look like `{\"error\": {\"code\", \"message\", \"details\"?}}`.\nLists return `{\"data\": [...], \"next_cursor\": \"...\"}`; pass `cursor` to get the next page.\nMutating requests accept an `Idempotency-Key` header: retries with the same key replay\nthe first response instead of running again.\n","title":"BTB Inventory & Sales API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/offers/attempts":{"post":{"description":"Stores a try that may not be an offer. `outcome` is `sent`, `unconfirmed`,\n`not_sent`, `refused`, `failed` or `skipped`. This does not create an offer.\nAmounts are integer cents.\n","operationId":"autoOffersCreateAttempt","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"reason":"already offered","account_id":1,"outcome":"skipped"},"schema":{"$ref":"#/components/schemas/AutoOfferAttempt"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AutoOfferAttemptResult"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Record an offer send attempt","tags":["Sync"]}},"/items/{id}/adjust":{"post":{"description":"Add or remove units outside a sale. Fails with `insufficient_stock` below zero.","operationId":"adjustStock","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"reason":"return","change":1,"note":"Buyer returned it"},"schema":{"$ref":"#/components/schemas/StockAdjustment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Item"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Adjust stock","tags":["Items"]}},"/listings/{id}/end-on-ebay":{"post":{"description":"Ends an eBay listing on eBay through the team's linked eBay account, then marks it delisted (clearing it from the delist queue). A listing that had already ended on eBay is marked delisted too. Fails with `platform_error` when eBay refuses (e.g. the account needs reconnecting) and leaves the listing as it was.","operationId":"endListingOnEbay","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Listing"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"End on eBay","tags":["Listings"]}},"/accounts/{id}/sync/payouts":{"put":{"description":"Writes `account_sync_state` for job `payouts`. Only `paused` is updated. Allowed with a\nread-only key (Payout Desk): it only chooses which sites BTB Everything reads. A paused\naccount's balance stays stored and is left out of the owed total from GET /balances.\n","operationId":"payoutSetSync","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"example":{"paused":true},"schema":{"$ref":"#/components/schemas/PayoutSync"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PayoutSyncState"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Pause or resume payout sync","tags":["Payouts"]}},"/listings/{id}/fields":{"put":{"description":"Writes that listing's title, description, price, category, photo order, and the\ncolumns of its marketplace table. `photo_ids` is this item's photo ids; the first\none is the cover. Unknown keys are ignored.\n","operationId":"crosslistUpdateFields","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"title":"Posh Custom","category":"200","price":"45.00","platform":"poshmark","photo_ids":[1,2]},"schema":{"$ref":"#/components/schemas/CrosslistFields"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CrosslistView"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Update one site's fields","tags":["Crosslist"]}},"/sales":{"get":{"description":"Most recent first, by `sold_at`.","operationId":"listSales","parameters":[{"description":"Sold at or after (ISO 8601).","in":"query","name":"from","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Sold before (ISO 8601).","in":"query","name":"to","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Only sales on this platform.","in":"query","name":"platform","required":false,"schema":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"}},{"description":"Page size.","in":"query","name":"limit","required":false,"schema":{"default":50,"maximum":200,"minimum":1,"type":"integer"}},{"description":"`next_cursor` from the previous page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Sale"},"type":"array"},"next_cursor":{"description":"Pass as `cursor` for the next page; null on the last page.","type":["string","null"]}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List sales","tags":["Sales"]},"post":{"description":"For sync clients that know the platform's ids but not BTB's. Identify what sold with\n`external_listing_id` + `platform`, `listing_id`, `item_id` or `sku`. Same effects as\n`/items/{id}/sell`: stock goes down and sell-outs flag other listings for delisting.\n\nAlways send `external_order_id`. If that order was already recorded on the platform, the\nexisting sale comes back with `200` and `already_recorded: true`, so re-running a sync is\nsafe. If the item has no stock left you get `409 oversold`: it may have sold twice.\n","operationId":"createSale","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"platform":"poshmark","external_listing_id":"6523f0c1a9","sold_at":"2026-10-26T18:04:00Z","external_order_id":"PM-88213","platform_fees":"9.00","sale_price":"45.00"},"schema":{"$ref":"#/components/schemas/SyncSaleCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleRecorded"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Oversold"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Record a sale by platform ids","tags":["Sync"]}},"/price-drop/plans/{id}/items/{item_id}":{"patch":{"description":"Sets include and pct, then recalculates the target. Only while the plan is a draft.","operationId":"priceDropUpdatePlanItem","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"include":false,"pct":"15.00"},"schema":{"$ref":"#/components/schemas/PriceDropPlanItemPatch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PriceDropPlanItem"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Edit a draft plan item","tags":["Price drop"]}},"/offer-runs":{"post":{"description":"Writes one `automation_run` for `offers_to_likers`, `favorite_offers`,\n`flyp_send_offers` or `reactivate_inactive`. Flyp eBay forces\n`people_count` to 0. Reactivate stores Seller Hub before and after in\n`details`.\n","operationId":"autoOffersCreateRun","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"status":"succeeded","details":{"after":4,"before":12},"summary":"reactivated","job":"reactivate_inactive","account_id":1,"people_count":0,"sent_count":2,"trigger":"manual"},"schema":{"$ref":"#/components/schemas/AutoOfferRun"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AutoOfferRunResult"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Record an auto-offer run","tags":["Sync"]}},"/offers":{"get":{"description":"Offers waiting on the seller, or every kind except `offer_to_likers`.\n`status=pending` is the inbox: buyer offers that are still pending.\nAmounts are integer cents.\n","operationId":"offerDeskList","parameters":[{"description":"Only offers in this status.","in":"query","name":"status","required":false,"schema":{"enum":["pending","accepted","declined","countered","expired","cancelled"],"type":"string"}},{"description":"Only offers on this platform.","in":"query","name":"platform","required":false,"schema":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Offer"},"type":"array"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List buyer offers","tags":["Offers"]}},"/accounts/{id}/offer-memory":{"get":{"description":"Liker memory and listing offer state for the given external listing ids.\nThe same buyer and listing inside the memory window is `already_handled`.\nDepop keeps a pair for 60 days. Vinted keeps it. Listing state older than\n180 days is left out.\n","operationId":"autoOffersMemory","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"description":"Comma-separated external listing ids.","in":"query","name":"listings","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AutoOfferMemory"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Offer memory for listings","tags":["Sync"]}},"/runs/{id}":{"patch":{"description":"Updates counters and status. A terminal status sets `finished_at` when it was empty.\nOptional `X-Device-Token`; a revoked token is 401.\n","operationId":"workerUpdateRun","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"status":"succeeded","total":3,"done":3},"schema":{"$ref":"#/components/schemas/WorkerRunUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkerRun"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Update an automation run","tags":["Worker"]}},"/price-drop/progress":{"get":{"operationId":"priceDropListProgress","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PriceDropProgress"},"type":"array"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List price-drop progress","tags":["Price drop"]}},"/conversations":{"put":{"description":"Stores the detected price only. `detected_offer_text` must be 140 characters or fewer.\nFull chat text is not stored.\n","operationId":"offerDeskUpsertConversation","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"platform":"facebook","external_thread_id":"fb-1","awaiting_reply":true,"detected_offer_cents":2500,"detected_offer_text":"Would you take 25?"},"schema":{"$ref":"#/components/schemas/ConversationUpsert"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Conversation"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Store a detected in-chat price","tags":["Offers"]}},"/me":{"get":{"description":"Returns the user and API key making the request. Use it to check a key works.","operationId":"getMe","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Me"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Who am I","tags":["Account"]}},"/devices":{"post":{"description":"Registers an extension device. The token is returned once; only its HMAC is stored.\nLater calls send it as the `X-Device-Token` header, or as JSON `device_token`.\n`Authorization: Bearer` remains the API key.\n","operationId":"workerCreateDevice","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"name":"Greg laptop","version":"1.4.0"},"schema":{"$ref":"#/components/schemas/WorkerDeviceCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkerDeviceCreated"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Register a device","tags":["Worker"]}},"/accounts/{id}/sync/{job}":{"get":{"description":"`account_sync_state` for this account and job: paused, cursor, watermarks,\n`blocked_until` and `last_error`.\n","operationId":"workerGetSyncState","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"job","required":true,"schema":{"description":"An automation_job name, such as sync_listings or follow.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkerSyncState"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Get account sync state","tags":["Worker"]},"put":{"description":"Creates or updates that sync state. Omitted fields on an existing row are kept.\n","operationId":"workerPutSyncState","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"job","required":true,"schema":{"description":"An automation_job name, such as sync_listings or follow.","type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"cursor":{"page":"2"},"paused":false,"last_error":null},"schema":{"$ref":"#/components/schemas/WorkerSyncWrite"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkerSyncState"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Save account sync state","tags":["Worker"]}},"/stats/summary":{"get":{"description":"Totals and net profit for a period.","operationId":"salesSummary","parameters":[{"description":"Sold at or after (ISO 8601).","in":"query","name":"from","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Sold before (ISO 8601).","in":"query","name":"to","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Only sales on this platform.","in":"query","name":"platform","required":false,"schema":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Summary"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Sales summary","tags":["Sales"]}},"/payouts":{"get":{"description":"Payouts for the team, newest `paid_at` first. `from` is inclusive and `to` is exclusive,\ncompared to `paid_at`. Paused accounts are included.\n","operationId":"payoutList","parameters":[{"description":"Only payouts on this platform.","in":"query","name":"platform","required":false,"schema":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"}},{"description":"Paid at or after (ISO 8601).","in":"query","name":"from","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Paid before (ISO 8601).","in":"query","name":"to","required":false,"schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Payout"},"type":"array"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List payouts","tags":["Payouts"]},"post":{"description":"Upserts on `(marketplace account, external_payout_id)` for the team's account on\n`platform` (eBay, Poshmark, Mercari, Vinted, Depop). The same external id updates that\nrow. A later sync that omits a payout does not delete it. `kind` is `withdrawal`,\n`sale_payout` or `clawback`. A clawback may be a negative `amount_cents`. Currency is\nthe account's currency. Omitted optional fields keep the stored value.\n","operationId":"payoutUpsert","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"status":"paid","kind":"clawback","method":"ach","platform":"depop","amount_cents":-350,"external_payout_id":"deposit:9","paid_at":"2026-11-01T12:00:00Z","fee_cents":0,"external_status":"taken back"},"schema":{"$ref":"#/components/schemas/PayoutUpsert"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Payout"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Store a payout","tags":["Payouts"]}},"/balances":{"get":{"description":"One row per account that has a stored balance. `owed_cents` on the envelope is the sum\nof account `owed_cents` for accounts whose payout sync is not paused. A paused account\nis still returned, with `paused: true`, and its owed amount is left out of that sum.\nNull owed counts as zero. Pending is not recomputed into owed.\n","operationId":"payoutListBalances","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBalanceList"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List marketplace balances","tags":["Payouts"]}},"/platforms":{"get":{"description":"Marketplaces items can be listed and sold on. Use the `slug` wherever a platform is expected.","operationId":"listPlatforms","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Platform"},"type":"array"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List platforms","tags":["Platforms"]}},"/accounts/{id}/rates":{"get":{"description":"Daily counters. `action` is follow, offer, post or share.","operationId":"workerListRates","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"description":"Only this action.","in":"query","name":"action","required":false,"schema":{"enum":["follow","offer","post","share"],"type":"string"}},{"description":"ISO date (YYYY-MM-DD).","in":"query","name":"day","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WorkerRate"},"type":"array"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List rate counters","tags":["Worker"]},"post":{"description":"Sets `n` for `(account, action, day)`. This replaces the count; it does not add.\nOmit `day` for today in the team's time zone.\n","operationId":"workerRecordRate","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"action":"follow","n":4,"day":"2026-11-05"},"schema":{"$ref":"#/components/schemas/WorkerRateWrite"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkerRate"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Set a rate counter","tags":["Worker"]}},"/items/{id}":{"delete":{"description":"Deletes the item with its listings, sales and stock history. Prefer archiving.","operationId":"deleteItem","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"204":{"description":"Success, no content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Delete an item","tags":["Items"]},"get":{"operationId":"getItem","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Item"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Get an item","tags":["Items"]},"patch":{"description":"Changes details only. Quantity changes go through `/adjust` or `/sell` so they're logged.","operationId":"updateItem","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"size":"M","title":"Patagonia Better Sweater (M)"},"schema":{"$ref":"#/components/schemas/ItemUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Item"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Update an item","tags":["Items"]}},"/to-ship":{"get":{"description":"Orders the extension last saw waiting to ship on Poshmark, eBay, Depop, Mercari, Vinted\nand Facebook. Each platform's `count` is null until a read succeeds. A failed read keeps\nthe last count, or null if there isn't one, and is not treated as zero. The top-level\n`count` adds up only the platforms that have a number. `item_id` is null when the SKU\nmatches no item on the team.\n","operationId":"toShipList","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToShipList"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Orders waiting to ship","tags":["Sync"]}},"/offers/sends":{"post":{"description":"Records a seller-initiated send. `kind` `offer_to_likers` stores one\nrecipient row per person, except Flyp (`via` `flyp`), which is items\nonly. Depop and Vinted store one buyer and listing in liker memory\n(`offered`, `skipped` or `gave_up`). A Mercari price that is not strictly\nunder `marketplace_last_otl_cents` is an attempt with outcome `refused`,\nnot an offer. Amounts are integer cents.\n","operationId":"autoOffersCreateSend","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"via":"ui_automation","listing":{"title":"Jacket","external_id":"dep-1","price_cents":2500,"likes":2},"kind":"offer_to_likers","account_id":1,"recipients":[{"username":"buyer-a","external_user_id":"buyer-a"}],"run_id":1,"amount_cents":2000,"verified_at":"2026-11-05T12:00:00Z"},"schema":{"$ref":"#/components/schemas/AutoOfferSend"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AutoOfferSendResult"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Record a seller offer send","tags":["Sync"]}},"/listing-issues/{id}/resolve":{"post":{"description":"Sets resolved_at once. A second call keeps the first timestamp.","operationId":"priceDropResolveIssue","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"resolution":"delisted the stale link"},"schema":{"$ref":"#/components/schemas/ListingIssueResolve"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ListingIssue"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Resolve a listing issue","tags":["Price drop"]}},"/offers/{id}/accept":{"post":{"description":"Enqueues a `respond_offer` listing task with `op` `accept`. A second accept of an\nalready decided offer returns that decision and does not enqueue again.\n","operationId":"offerDeskAccept","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Offer"},"enqueued":{"type":"boolean"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Accept an offer","tags":["Offers"]}},"/items":{"get":{"description":"Newest first, with each item's listings.","operationId":"listItems","parameters":[{"description":"Only items with this status.","in":"query","name":"status","required":false,"schema":{"enum":["draft","active","sold","archived"],"type":"string"}},{"description":"Case-insensitive match on title, SKU or brand.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Page size.","in":"query","name":"limit","required":false,"schema":{"default":50,"maximum":200,"minimum":1,"type":"integer"}},{"description":"`next_cursor` from the previous page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Item"},"type":"array"},"next_cursor":{"description":"Pass as `cursor` for the next page; null on the last page.","type":["string","null"]}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List items","tags":["Items"]},"post":{"description":"The item is the universal listing template: title, description, price, photos, condition,\nsize and shipping details live here once and every platform listing uses them. New items\nstart as `draft` and become `active` once listed.\n","operationId":"createItem","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"size":"M","title":"Patagonia Better Sweater","tags":["patagonia","fleece"],"condition":"like_new","department":"men","brand":"Patagonia","original_price":"139.00","price":"55.00","weight_oz":"18","sku":"PAT-001","cost":"8.00"},"schema":{"$ref":"#/components/schemas/ItemCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Item"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Create an item","tags":["Items"]}},"/imports/ebay":{"post":{"description":"Creates or refreshes the item and its eBay listing from the extension.\nA later import updates eBay and the general fields. A site title, description,\nor price the seller already changed is left as they set it. Returns 201 the\nfirst time and 200 when the same eBay listing is imported again.\n","operationId":"crosslistImportEbay","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"description":"Light wash trucker jacket","title":"Vintage denim jacket","condition":"good","price":"45.00","sku":"JKT-1","photos":["https://cdn.example/1.jpg","https://cdn.example/2.jpg"],"quantity":1,"external_id":"123456789012","package":{"height_in":"2","length_in":"12","weight_oz":"16","width_in":"10"},"specifics":{"Brand":"Levi's"}},"schema":{"$ref":"#/components/schemas/CrosslistImport"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CrosslistView"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Import an eBay listing","tags":["Crosslist"]}},"/devices/heartbeat":{"post":{"description":"Updates `version`, `last_seen_at` and `signed_in`. Identify the device with\n`X-Device-Token` or JSON `device_token`. A revoked device returns 401.\n`signed_in` maps this team's marketplace account ids to ISO 8601 times.\nOmitting it clears the map.\n","operationId":"workerHeartbeatDevice","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"version":"1.4.0","signed_in":{"12":"2026-11-05T18:00:00Z"},"device_token":"btd_example"},"schema":{"$ref":"#/components/schemas/WorkerHeartbeat"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkerDevice"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Device heartbeat","tags":["Worker"]}},"/platforms/{platform}/taxonomy":{"get":{"description":"Categories and attribute definitions stored for that platform. An empty list means nothing is synced yet.","operationId":"crosslistTaxonomy","parameters":[{"in":"path","name":"platform","required":true,"schema":{"examples":["poshmark"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CrosslistTaxonomy"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Marketplace taxonomy","tags":["Crosslist"]}},"/schedules":{"get":{"description":"Schedules for the team. Each row sets `interval_minutes` or `daily_at`, never both.\nA null `marketplace_account_id` is the team-wide schedule for that job.\n","operationId":"workerListSchedules","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WorkerSchedule"},"type":"array"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List sync schedules","tags":["Worker"]},"put":{"description":"Upserts `(team, account or team-wide, job)`. Send exactly one of `interval_minutes`\nor `daily_at`; the other is cleared. `daily_at` is a clock time `HH:MM:SS`.\n","operationId":"workerPutSchedule","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"enabled":true,"job":"follow","interval_minutes":30},"schema":{"$ref":"#/components/schemas/WorkerScheduleWrite"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkerSchedule"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Upsert a sync schedule","tags":["Worker"]}},"/payouts/reads":{"get":{"description":"Per site: `read_at` (last good read), `tried_at`, `error` (only while newer than the\nlast good read), `history_from` (the site's own history starts there) and `backfilled`.\n","operationId":"payoutReads","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Each site's last read","tags":["Payouts"]}},"/listing-issues":{"get":{"operationId":"priceDropListIssues","parameters":[{"description":"When true, only issues with no resolved_at.","in":"query","name":"open","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ListingIssue"},"type":"array"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List listing issues","tags":["Price drop"]},"post":{"operationId":"priceDropCreateIssue","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"kind":"stale_link","sku_text":"PAT-001"},"schema":{"$ref":"#/components/schemas/ListingIssueCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ListingIssue"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Open a listing issue","tags":["Price drop"]}},"/accounts/{id}/offer-rules/{job}":{"get":{"description":"Settings for one auto-offer job on a marketplace account. Jobs are\n`offers_to_likers`, `favorite_offers`, `flyp_send_offers` and\n`reactivate_inactive`. A job with no saved row is returned disabled.\nMoney fields are integer cents.\n","operationId":"autoOffersGetRule","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"job","required":true,"schema":{"description":"An automation_job name, such as sync_listings or follow.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AutoOfferRule"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Get an auto-offer rule","tags":["Sync"]},"put":{"description":"Replaces the rule for that account and job. `shipping_discount_option`\nis `none`, `499` or `free`. `min_basis` is `price` or `earnings`.\n`min_amount_cents` is an integer number of cents. Cookies and passwords\nare not accepted.\n","operationId":"autoOffersUpdateRule","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"job","required":true,"schema":{"description":"An automation_job name, such as sync_listings or follow.","type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"enabled":true,"interval_minutes":30,"discount_pct":15,"shipping_discount_option":"499","min_basis":"earnings","min_amount_cents":1500,"exclude_listed_within_days":2,"like_lookback_days":7,"lower_to_pct":10,"max_per_run":20},"schema":{"$ref":"#/components/schemas/AutoOfferRuleWrite"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AutoOfferRule"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Save an auto-offer rule","tags":["Sync"]}},"/offers/{id}/decline":{"post":{"description":"Enqueues a `respond_offer` listing task with `op` `decline`.","operationId":"offerDeskDecline","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"message":"No thanks"},"schema":{"$ref":"#/components/schemas/OfferDecline"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Offer"},"enqueued":{"type":"boolean"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Decline an offer","tags":["Offers"]}},"/templates":{"get":{"description":"The seller's templates: fields, defaults, rules and title/description patterns.","operationId":"listTemplates","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ListingTemplate"},"type":"array"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List listing templates","tags":["Templates"]}},"/price-drop/plans/{id}/start":{"post":{"description":"Sets the plan to running. Included items get progress and a started step per live\nlisting: `price`, plus `relist` when that marketplace is in `relist_marketplace_ids`.\nItems with include false are skipped and get no steps.\n","operationId":"priceDropStartPlan","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PriceDropPlan"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Start a price-drop plan","tags":["Price drop"]}},"/runs":{"post":{"description":"`job` is an automation_job. `trigger` is scheduled, manual, turned_on or job.\n`mode` is full or quick. `status` is running, succeeded, problem, failed, stopped\nor timed_out. Optional `X-Device-Token` sets `device_id`; a revoked token is 401.\n","operationId":"workerCreateRun","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"status":"running","mode":"quick","job":"sync_listings","trigger":"manual"},"schema":{"$ref":"#/components/schemas/WorkerRunCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkerRun"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Open an automation run","tags":["Worker"]}},"/offers/{id}/result":{"post":{"description":"The extension reports how accept, decline, or counter finished and the listing task\ncompletes. `error` or `blocked: true` puts a seller decision back to pending.\n`blocked: true` sets `counter_blocked_until` seven days out.\n","operationId":"offerDeskResult","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"error":null,"blocked":false,"status":"accepted","decided_by":"seller"},"schema":{"$ref":"#/components/schemas/OfferResult"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Offer"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Record a marketplace answer","tags":["Offers"]}},"/offers/{id}/counter":{"post":{"description":"Enqueues a `respond_offer` listing task with `op` `counter`. The amount must be above\nthe buyer's offer and, when set, inside `counter_min_cents` and `counter_max_cents`.\nOtherwise the response is 422. A counter the buyer might accept sets `follow_until`\nfour days out. `blocked: true` records eBay's limit for seven days and does not enqueue.\nAmounts are integer cents.\n","operationId":"offerDeskCounter","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"message":"Meet you part way","amount_cents":1999},"schema":{"$ref":"#/components/schemas/OfferCounter"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Offer"},"enqueued":{"type":"boolean"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Counter an offer","tags":["Offers"]}},"/accounts/{id}/lease":{"delete":{"description":"Drops the lease when this device holds it, or when it is already free.\nA live lease held by another device is 409 `lease_held`. Send `X-Device-Token`\nor JSON `device_token`.\n","operationId":"workerReleaseLease","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"204":{"description":"Success, no content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Release an account lease","tags":["Worker"]},"post":{"description":"Takes or renews the lease via `claim_account_lease` (default 120 seconds, max 86400).\nA second device cannot take a live lease (409 `lease_held`). Send `X-Device-Token`\nor JSON `device_token`. A revoked device returns 401.\n","operationId":"workerLeaseAccount","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"seconds":120},"schema":{"$ref":"#/components/schemas/WorkerLeaseRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkerLease"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Lease an account","tags":["Worker"]}},"/templates/{id}":{"get":{"operationId":"getTemplate","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ListingTemplate"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Get a listing template","tags":["Templates"]}},"/items/{id}/stock-movements":{"get":{"description":"Every quantity change for the item, newest first.","operationId":"listStockMovements","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/StockMovement"},"type":"array"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Stock history","tags":["Items"]}},"/listings":{"get":{"description":"Use `status=needs_delist` for the delist queue.","operationId":"listListings","parameters":[{"description":"Only listings with this status.","in":"query","name":"status","required":false,"schema":{"enum":["active","needs_delist","delisted","sold"],"type":"string"}},{"description":"Only listings on this platform.","in":"query","name":"platform","required":false,"schema":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"}},{"description":"Only listings of this item.","in":"query","name":"item_id","required":false,"schema":{"type":"integer"}},{"description":"Only listings with this platform listing id.","in":"query","name":"external_id","required":false,"schema":{"type":"string"}},{"description":"Page size.","in":"query","name":"limit","required":false,"schema":{"default":50,"maximum":200,"minimum":1,"type":"integer"}},{"description":"`next_cursor` from the previous page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Listing"},"type":"array"},"next_cursor":{"description":"Pass as `cursor` for the next page; null on the last page.","type":["string","null"]}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List listings","tags":["Listings"]}},"/payouts/refresh":{"post":{"description":"Asks the computer where BTB Everything is On to read these sites' balances and payouts\nnow (`sites`, else all). The numbers arrive on GET /balances and GET /payouts when it's\ndone. 409 `no_computer` when BTB Everything isn't On anywhere.\n","operationId":"payoutRefresh","parameters":[],"requestBody":{"content":{"application/json":{"example":{"sites":["depop"]},"schema":{"properties":{"sites":{"items":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"asked":{"type":"boolean"}},"type":"object"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Read the sites now","tags":["Payouts"]}},"/payouts/import":{"post":{"description":"Payout Desk 0.5.0's one-time copy of what it kept: per site (`ebay`, `poshmark`,\n`mercari`, `vinted`, `depop`) the balance (`available`, `pending`, `owed`, dollars),\n`payouts` (`id`, `at`, `amount`, `status`, `sale`) and `state` (`backfilled`,\n`settled`, `historyFrom`). Payouts upsert by their site id, so sending it again only\nupdates. Answers per site how many payouts were saved and how many failed.\n","operationId":"payoutImport","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"sites":{"depop":{"pending":30.0,"state":{"backfilled":true,"historyFrom":"2026-01-01","settled":[]},"available":120.5,"payouts":[{"id":"deposit:9","status":"Bank deposit","at":"2026-11-02T15:00:00Z","amount":400.0}]}}},"schema":{"properties":{"sites":{"description":"Site slug → its stored data.","type":"object"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Import Payout Desk's stored history","tags":["Payouts"]}},"/price-drop/items/{item_id}/steps":{"put":{"description":"One row per item, listing, and step. Sending `done` again keeps that one row.\nA later `started` does not change a step that is already done.\n","operationId":"priceDropPutStep","parameters":[{"in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"error":null,"status":"done","step":"price","listing_id":1,"target_price_cents":3199},"schema":{"$ref":"#/components/schemas/PriceDropStepWrite"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PriceDropStep"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Record a price-drop step","tags":["Price drop"]}},"/sales/{id}/profit":{"post":{"description":"`earnings_cents` is stored as `reported_payout_cents`. The sale then leaves profit-needed.","operationId":"priceDropRecordProfit","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"earnings_cents":2500},"schema":{"$ref":"#/components/schemas/SaleProfitWrite"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/SaleProfit"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Record sale earnings","tags":["Price drop"]}},"/price-drop/rules":{"get":{"description":"The team's rule. Defaults are returned before one is saved.","operationId":"priceDropGetRule","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PriceDropRule"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Get the price-drop rule","tags":["Price drop"]},"put":{"description":"Creates or updates the team's rule. `pct` is 1 to 90.","operationId":"priceDropPutRule","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"rounding":"x99","batch_size":25,"pct":"20.00","min_active_listings":4,"min_days_since_change":61,"min_last_change_on":"2026-02-15","relist_marketplace_ids":[2,3,5]},"schema":{"$ref":"#/components/schemas/PriceDropRuleWrite"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PriceDropRule"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Save the price-drop rule","tags":["Price drop"]}},"/sales/{id}":{"delete":{"description":"Undoes a sale: restores stock and reopens listings flagged for delisting.","operationId":"voidSale","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"204":{"description":"Success, no content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Void a sale","tags":["Sales"]},"get":{"operationId":"getSale","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Sale"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Get a sale","tags":["Sales"]}},"/items/{id}/sell":{"post":{"description":"Records the sale and decrements stock in one transaction. If the item sells out, the\nlisting it sold through becomes `sold` and its other active listings become\n`needs_delist`; those are returned in `needs_delist` so you can take them down.\n\nPass `listing_id`, or just `platform` and the item's live listing there is linked\nautomatically. Send `external_order_id` (or an `Idempotency-Key`) to make retries safe.\n","operationId":"recordSale","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"platform":"poshmark","external_order_id":"PM-88213","platform_fees":"9.00","sale_price":"45.00","shipping_charged":"7.97"},"schema":{"$ref":"#/components/schemas/SaleCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleRecorded"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Oversold"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Record a sale","tags":["Sales"]}},"/to-ship/snapshots":{"post":{"description":"One platform's current unshipped orders. Match an existing sale by `external_order_id`,\notherwise an item and its live listing by SKU, otherwise store the line with no item.\nSend `error` when the site could not be read: the previous list is kept and the error is\nstored for that platform. A body without `error` is the full waiting list, and orders that\nare no longer in it are marked shipped. Does not change stock.\n","operationId":"toShipSnapshot","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"error":null,"count":1,"items":[{"title":"Patagonia Better Sweater","url":"https://poshmark.com/order/sales/PM-88213","sku":"PAT-001","external_order_id":"PM-88213"}],"platform":"poshmark"},"schema":{"$ref":"#/components/schemas/ToShipSnapshot"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToShipList"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Store a to-ship snapshot","tags":["Sync"]}},"/items/{id}/listing":{"get":{"description":"Everything needed to post the item on one platform: title, description, condition (and\ncondition description), category and store category, custom label, item specifics,\nprice, photos, policies and package. Rendered through the item's listing template for that\nplatform when it has one, otherwise from the universal template. `warnings` lists anything\nto fix first; `ready` is true when there's nothing.\n","operationId":"getRenderedListing","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"description":"Platform to render for (required).","in":"query","name":"platform","required":false,"schema":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RenderedListing"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Finished listing for a platform","tags":["Templates"]}},"/offers/stats":{"get":{"description":"Waiting, received, accepted, countered, counters accepted, and deal rate.\nOffers to likers are excluded. `from` is inclusive and `to` is exclusive.\nWaiting is the current buyer inbox and ignores the window. Amounts are integer cents.\n","operationId":"offerDeskStats","parameters":[{"description":"Only offers on this platform.","in":"query","name":"platform","required":false,"schema":{"description":"Platform slug from GET /platforms.","examples":["ebay"],"type":"string"}},{"description":"Inclusive start (ISO 8601).","in":"query","name":"from","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Exclusive end (ISO 8601).","in":"query","name":"to","required":false,"schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OfferStats"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Offer desk stats","tags":["Offers"]}},"/tasks/claim":{"post":{"description":"Locks due pending `listing_task` and `account_task` rows for accounts this device\ncurrently leases (`status` running, `locked_at`, `locked_by_device_id`).\nRows locked by another device are left alone. Send `X-Device-Token`.\nClaiming does not increment `attempts`.\n","operationId":"workerClaimTasks","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkerClaim"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Claim due tasks","tags":["Worker"]}},"/price-drop/plans":{"post":{"description":"Draft plan from the enabled rule. Qualifying items are the oldest last-changed\nfirst. `x99` rounding lowers by `pct`, then snaps to the nearest price ending\nin .99, and never goes under 99 cents. Amounts are integer cents.\n","operationId":"priceDropCreatePlan","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PriceDropPlan"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Build a price-drop plan","tags":["Price drop"]}},"/sales/sync":{"post":{"description":"Sales whose sold_at is inside the window and whose external_order_id is absent\nfrom `orders` are marked cancelled. Sales outside the window are kept.\n","operationId":"priceDropSyncSales","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"from":"2026-06-01T00:00:00Z","orders":[{"platform":"poshmark","external_order_id":"PM-88213"}],"to":"2026-06-30T23:59:59Z"},"schema":{"$ref":"#/components/schemas/SalesSync"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/SalesSyncResult"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Sync orders in a window","tags":["Price drop"]}},"/offers/inbox":{"post":{"description":"Stores threads and offers from a marketplace read. The same\n`(external_offer_id, initiated_by)` updates the existing row.\n`kind` is `buyer_offer` or `counter`. Does not call the marketplace.\nAmounts are integer cents.\n","operationId":"offerDeskInbox","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"threads":[{"offers":[{"currency":"USD","kind":"buyer_offer","amount_cents":2200,"listing_price_cents":4500,"initiated_by":"buyer","external_offer_id":"off-1"}],"external_listing_id":"v1","external_thread_id":"thread-v1","history_partial":false}],"platform":"vinted"},"schema":{"$ref":"#/components/schemas/OfferInbox"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OfferInboxResult"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Upsert an offer inbox","tags":["Offers"]}},"/items/{id}/crosslist":{"get":{"description":"General fields plus each marketplace's status and site-specific fields. Photo position 0 is the cover.","operationId":"crosslistShow","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CrosslistView"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Crosslist an item","tags":["Crosslist"]}},"/tasks/{kind}/{id}/result":{"post":{"description":"`kind` is `listing` or `account`. `error` is stored as `last_error`.\n`progress` is stored on account tasks; listing tasks have no progress column.\nA finished task is returned unchanged so a retry does not increment `attempts`.\nSend `X-Device-Token`. The same `Idempotency-Key` replays the first response.\n","operationId":"workerRecordTaskResult","parameters":[{"in":"path","name":"kind","required":true,"schema":{"description":"`listing` for a listing_task, `account` for an account_task.","enum":["listing","account"],"type":"string"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"error":null,"status":"succeeded"},"schema":{"$ref":"#/components/schemas/WorkerTaskResult"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/WorkerTask"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Record a task result","tags":["Worker"]}},"/listings/{id}":{"delete":{"description":"Removes the record entirely. Prefer `/delist` to keep history.","operationId":"deleteListing","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"204":{"description":"Success, no content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Delete a listing","tags":["Listings"]},"get":{"operationId":"getListing","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Listing"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Get a listing","tags":["Listings"]},"patch":{"operationId":"updateListing","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"price":"49.99"},"schema":{"$ref":"#/components/schemas/ListingUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Listing"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Update a listing","tags":["Listings"]}},"/listings/{id}/delist":{"post":{"description":"Confirms the listing was taken down on its platform. Clears it from the delist queue.","operationId":"delistListing","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Listing"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Mark as delisted","tags":["Listings"]}},"/items/{id}/listings":{"post":{"description":"Listings use the item as their template (title, description, photos, price), so usually you\nonly say where: `platform`, plus `url`/`external_id` once it's live. An item can have one live\nlisting per platform.\n","operationId":"createListing","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"url":"https://www.ebay.com/itm/123","platform":"ebay","external_id":"123"},"schema":{"$ref":"#/components/schemas/ListingCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Listing"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List an item on a platform","tags":["Listings"]}},"/sales/profit-needed":{"get":{"description":"Sales with no `reported_payout_cents`. Cancelled and unpaid orders are left out.","operationId":"priceDropListProfitNeeded","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SaleProfitNeeded"},"type":"array"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Sales missing earnings","tags":["Price drop"]}},"/accounts/{id}/balance":{"put":{"description":"Upserts the one balance row for this marketplace account. Amounts are integer cents.\n`owed_cents` is stored as sent: Poshmark pending is not added in. Send `owed_cents`\nequal to available when pending should stay out of the owed total.\n","operationId":"payoutUpsertBalance","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"currency":"USD","available_cents":4200,"pending_cents":1500,"owed_cents":4200,"total_cents":5700,"captured_at":"2026-11-05T15:00:00Z"},"schema":{"$ref":"#/components/schemas/PayoutBalanceUpsert"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PayoutBalance"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Store a marketplace balance","tags":["Payouts"]}},"/offer-threads":{"get":{"description":"`follow=due` returns threads whose `follow_until` is now or earlier.","operationId":"offerDeskThreads","parameters":[{"description":"Pass due for threads that should be re-read.","in":"query","name":"follow","required":false,"schema":{"enum":["due"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OfferThread"},"type":"array"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"List offer threads","tags":["Offers"]}},"/store-size":{"post":{"description":"One reading per team per day. A second post for the same day replaces the qty.","operationId":"priceDropRecordStoreSize","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"day":"2026-06-02","qty":120},"schema":{"$ref":"#/components/schemas/StoreSizeWrite"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/StoreSize"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Record daily store size","tags":["Price drop"]}},"/listings/{id}/publish":{"post":{"description":"Enqueues a `publish` task, or `update` when the listing already has an external id.\nTitle and price are required. Category is required too. Missing fields return 422\nand nothing is enqueued.\n","operationId":"crosslistPublish","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CrosslistTask"}},"type":"object"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Enqueue publish","tags":["Crosslist"]}},"/platforms/{platform}/listings/{external_id}":{"put":{"description":"Upserts the listing with this platform listing id. Returns `201` when created, `200` when\nupdated. Updating changes price, URL and status but never moves the listing to another item.\n\nTo create, say which item it's for: `item_id`, `sku`, or an `item` object. With `sku` + `item`,\nthe item is created if the SKU is new. Set `status` to `delisted` to confirm a takedown, or\n`sold` when it sold.\n","operationId":"upsertExternalListing","parameters":[{"in":"path","name":"platform","required":true,"schema":{"examples":["poshmark"],"type":"string"}},{"in":"path","name":"external_id","required":true,"schema":{"description":"The platform's own listing id.","type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"example":{"item":{"title":"Patagonia Better Sweater","brand":"Patagonia","cost":"8.00"},"url":"https://poshmark.com/listing/6523f0c1a9","price":"55.00","sku":"PAT-001"},"schema":{"$ref":"#/components/schemas/SyncListingUpsert"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingUpserted"}}},"description":"Success"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/ValidationFailed"},"429":{"$ref":"#/components/responses/RateLimited"}},"summary":"Create or update a listing by platform id","tags":["Sync"]}}},"security":[{"bearerAuth":[]}],"servers":[{"url":"https://btb.net/api/v1"}],"tags":[{"name":"Account"},{"name":"Platforms"},{"name":"Items"},{"name":"Listings"},{"name":"Sales"},{"name":"Sync"},{"name":"Templates"},{"name":"Worker"},{"name":"Payouts"},{"name":"Offers"},{"name":"Crosslist"},{"name":"Price drop"}]}