/auction_kr/products

POST /api/auction_kr/products

Price: 20 credits

Get an Auction (auction.co.kr) product by item number or URL: price, coupon price, images, seller, category, rating, purchase count, stock, delivery details, product notice and option stock

How to use it

Item numbers come from auction_kr/products/search, auction_kr/products/best or auction_kr/sellers/items. For rentals price is the monthly fee and rental_terms holds the contract terms.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Auction item number or item URL (examples: "B549609785", "https://itempage3.auction.co.kr/DetailView.aspx?itemno=B549609785"; minLength: 1)

Response

• @type string (default: "AuctionKrProduct")
• id string required
• url string required
• name string required
• brand string nullable
• is_official_brand boolean (default: false)
• image string nullable
• images array (default: [])
• currency string (default: "KRW")
• price number nullable
• original_price number nullable
• coupon_price number nullable
• discount_rate integer nullable
• is_rental boolean (default: false)
• rental_terms array (default: [])
• rating number nullable
• review_count integer nullable
• purchase_count integer nullable
• stock_quantity integer nullable
• question_count integer nullable
• category object nullable
  • @type string (default: "AuctionKrProductCategory")
  • large_code string nullable
  • medium_code string nullable
  • medium_name string nullable
  • small_code string nullable
  • small_name string nullable
• seller object nullable
  • @type string (default: "AuctionKrProductSeller")
  • id string nullable
  • name string nullable
  • store_alias string nullable
  • store_url string nullable
• origin string nullable
• condition string nullable
• is_star_delivery boolean (default: false)
• shipping_tags array (default: [])
• delivery_details array (default: [])
  • @type string (default: "AuctionKrProductSpec")
  • name string required
  • value string nullable
• arrival_estimates array (default: [])
  • @type string (default: "AuctionKrArrivalEstimate")
  • arrival_date integer required
  • probability integer required
• arrival_guarantee string nullable
• order_cutoff string nullable
• specifications array (default: [])
  • @type string (default: "AuctionKrProductSpec")
  • name string required
  • value string nullable
• options array (default: [])
  • @type string (default: "AuctionKrProductOption")
  • group string nullable
  • name string nullable
  • detail string nullable
  • stock_no string nullable
  • stock_quantity integer nullable
  • price_delta number nullable
  • image string nullable
  • is_available boolean (default: true)

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 — No Auction item under that number 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.