/ssg/products/search

POST /api/ssg/products/search

Price: 10 credits

Search SSG.COM items by keyword with order and delivery type: name, brand, image, price, original price, discount, shipping, stock, sold-out and ad flags

How to use it

Pass a returned id to ssg/products for the full item, ssg/products/reviews or ssg/products/questions.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "노트북", "계란"; minLength: 1)
• sort string — Result order (default: "recommended"; one of: "recommended", "best_selling", "price_low", "price_high", "discount", "newest", "most_reviewed")
• delivery string — Delivery or store type (default: "any"; one of: "any", "weekly", "department_store", "dawn", "traders", "store_pickup")
• count integer required — Max number of results (min: 1; max: 10000)

Response

• @type string (default: "SsgSearchItem")
• id string required
• url string required
• name string nullable
• brand_name string nullable
• image string nullable
• site_no string nullable
• store_no string nullable
• option_id string nullable
• currency string (default: "KRW")
• price number nullable
• original_price number nullable
• reference_price number nullable
• discount_rate number nullable
• rating number nullable
• review_count integer nullable
• shipping array (default: [])
• stock_quantity integer nullable
• min_order_quantity integer nullable
• is_sold_out boolean nullable
• is_stopped_selling boolean nullable
• is_ad boolean nullable
• is_adult boolean nullable
• vendor_id string nullable
• parent_vendor_id 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.