/poshmark/items/related

POST /api/poshmark/items/related

Price: 20 credits

List Poshmark listings related to a given listing by ID or URL

How to use it

List listings related to a given Poshmark listing (by ID or URL). Choose the marketplace region (poshmark.com US / poshmark.ca CA). Returns each related listing's title, price, brand, size, photos and the seller.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• domain string — Poshmark marketplace region to query (default: "poshmark.com"; one of: "poshmark.com", "poshmark.ca")
• item string required — Poshmark listing ID or listing URL (examples: "6a3eb9e824f3b810cb841281"; minLength: 1)
• count integer required — Max number of related listings to return (examples: 40; min: 1)

Response

• @type string (default: "PoshmarkListingSummary")
• id string required
• url string required
• description string nullable
• brand string nullable
• brand_id string nullable
• price object nullable
  • @type string (default: "PoshmarkPrice")
  • amount number nullable
  • currency string nullable
  • currency_symbol string nullable
• original_price object nullable
  • @type string (default: "PoshmarkPrice")
  • amount number nullable
  • currency string nullable
  • currency_symbol string nullable
• condition string nullable
• size string nullable
• size_system string nullable
• colors array (default: [])
  • @type string (default: "PoshmarkColor")
  • name string required
  • rgb string nullable
• department object nullable
  • @type string (default: "PoshmarkCategoryNode")
  • id string nullable
  • display string nullable
  • slug string nullable
• category object nullable
  • @type string (default: "PoshmarkCategoryNode")
  • id string nullable
  • display string nullable
  • slug string nullable
• subcategories array (default: [])
  • @type string (default: "PoshmarkCategoryNode")
  • id string nullable
  • display string nullable
  • slug string nullable
• image string nullable
• images array (default: [])
• status string nullable
• availability string nullable
• share_count integer (default: 0)
• like_count integer (default: 0)
• comment_count integer (default: 0)
• has_offer boolean (default: false)
• created_at integer nullable
• first_published_at integer nullable
• updated_at integer nullable
• seller object nullable
  • @type string (default: "PoshmarkUserMini")
  • id string nullable
  • alias string nullable
  • display_handle string nullable
  • full_name string nullable
  • image string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.