/netaporter/products/search

POST /api/netaporter/products/search

Price: 20 credits

Search Net-a-Porter products by keywords, filtered by designer, color, size, fabric, print, heel height, metal, stone, style, bag line, badge, sustainability, activity and price range

How to use it

Keyword search over the Net-a-Porter store of the chosen region. Each row is one color of a product; its id is accepted by the Net-a-Porter product and related endpoints. Prices follow region.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• region string — Store region; it sets the assortment and the currency (default: "us"; one of: "us", "ca")
• sort string — Result ordering (default: "recommended"; one of: "recommended", "new_in", "price_desc", "price_asc", "discount_desc")
• min_price number nullable — Lowest price in the region currency (min: 0)
• max_price number nullable — Highest price in the region currency (min: 0)
• designers array nullable — Designer names as shown on Net-a-Porter (examples: ["Gucci","Saint Laurent"])
• colors array nullable — Colors (one of: "animal_print", "black", "blue", "brown", "burgundy", "colorless", "cream", "ecru", "gold", "gray", "green", "ivory", "metallic", "multi", "natural", "neutrals", "off_white", "orange", "pink", "purple", "red", "rose_gold", "silver", "tortoiseshell", "unknown", "white", "white_gold", "yellow")
• sizes array nullable — Sizes, prefixed by size chart (one of: "accessories_l", "accessories_m", "accessories_s", "accessories_xl", "accessories_xs", "belts_us_0", "belts_us_00", "belts_us_10", "belts_us_12", "belts_us_14", "belts_us_16", "belts_us_18", "belts_us_2", "belts_us_20", "belts_us_4", "belts_us_6", "belts_us_8", "bras_32a", "bras_32b", "bras_32c", "bras_32d", "bras_32dd", "bras_32e", "bras_34a", "bras_34b", "bras_34c", "bras_34d", "bras_34dd", "bras_34e", "bras_36a", "bras_36b", "bras_36c", "bras_36d", "bras_38b", "bras_38c", "bras_38d", "clothing_us_0", "clothing_us_00", "clothing_us_10", "clothing_us_12", "clothing_us_14", "clothing_us_15", "clothing_us_16", "clothing_us_18", "clothing_us_2", "clothing_us_20", "clothing_us_22", "clothing_us_24", "clothing_us_26", "clothing_us_28", "clothing_us_4", "clothing_us_6", "clothing_us_8", "hats_6_1_2", "hats_6_3_4", "hats_6_5_8", "hats_6_7_8", "hats_7", "hats_7_1_4", "hats_7_1_8", "hats_7_3_8", "int_l", "int_m", "int_s", "int_xl", "int_xs", "int_xxl", "int_xxs", "int_xxxs", "rings_2", "rings_2_1_2", "rings_3", "rings_3_1_2", "rings_4", "rings_4_1_2", "rings_4_1_4", "rings_4_3_4", "rings_5", "rings_5_1_2", "rings_5_1_4", "rings_5_3_4", "rings_6", "rings_6_1_2", "rings_6_1_4", "rings_6_3_4", "rings_7", "rings_7_1_2", "rings_7_1_4", "rings_7_3_4", "rings_8", "rings_8_1_2", "rings_8_1_4", "rings_8_3_4", "rings_9", "shoes_us_10", "shoes_us_10_5", "shoes_us_11", "shoes_us_11_5", "shoes_us_12", "shoes_us_12_5", "shoes_us_13", "shoes_us_3", "shoes_us_3_5", "shoes_us_4", "shoes_us_4_5", "shoes_us_5", "shoes_us_5_5", "shoes_us_6", "shoes_us_6_5", "shoes_us_7", "shoes_us_7_5", "shoes_us_8", "shoes_us_8_5", "shoes_us_9", "shoes_us_9_5")
• fabrics array nullable — Fabrics (one of: "alpaca", "cashmere", "chiffon", "cotton", "crepe", "denim", "faux_leather", "flannel", "jersey", "lace", "leather", "linen", "mohair", "satin", "sequined", "silk", "suede", "taffeta", "tulle", "velour", "velvet", "wool")
• prints array nullable — Print or solid color (one of: "logo_and_graphic", "print", "solid_color")
• heel_heights array nullable — Shoe heel heights (one of: "flat", "high_heel", "kitten_heel", "mid_heel", "wedge")
• metals array nullable — Jewelry metals (one of: "platinum", "rose_gold", "two_golds", "white_gold", "yellow_gold")
• stones array nullable — Jewelry stones (one of: "diamond", "emerald", "pearl", "ruby", "sapphire")
• styles array nullable — Style attributes, prefixed by product type (one of: "body_jewelry_anklets", "body_jewelry_body_chains", "bra_balconette", "bra_bralette", "bra_full_cup", "bra_plunge", "bra_size_type_all_other_sizes", "bra_soft_cup", "bra_strapless_and_multiway", "bra_triangle", "bra_wiring_non_wired", "bra_wiring_underwired", "bracelets_bangles", "bracelets_beaded_bracelets", "bracelets_chain_bracelets", "bracelets_charm_bracelets", "bracelets_cuffs", "coats_and_jackets_belted_coats", "coats_and_jackets_blazers", "coats_and_jackets_bomber_and_track_jackets", "coats_and_jackets_capes_and_kaftans", "coats_and_jackets_denim_jackets", "coats_and_jackets_faux_fur_shearling", "coats_and_jackets_leather_jackets", "coats_and_jackets_quilted_down_puffer_jackets", "coats_and_jackets_shirt_and_utility_jackets", "coats_and_jackets_sports_jacket", "coats_and_jackets_trench_coats", "coats_and_jackets_wool_coats", "coats_belted_coats", "coats_capes", "coats_double_breasted", "coats_shearling", "coats_trench_coats", "coats_wool_coats", "department_fine_jewelry", "department_jewelry", "dresses_beach_dresses", "dresses_bridal_dresses", "dresses_day_dresses", "dresses_embellished_dresses", "dresses_evening_dresses", "dresses_floral_dresses", "dresses_gowns", "dresses_kaftan_dresses", "dresses_knit_dresses", "dresses_modest_dresses", "dresses_off_the_shoulder_dresses", "dresses_party_dresses", "dresses_shirt_dresses", "dresses_slip_dresses", "dresses_sun_dresses", "dresses_wrap_dresses", "earrings_clip_ons", "earrings_drop_earrings", "earrings_ear_cuffs", "earrings_hoops", "earrings_singles", "earrings_studs", "movement_automatic", "movement_quartz", "necklaces_beaded_necklaces", "necklaces_chain_necklaces", "necklaces_chokers", "necklaces_lariats", "necklaces_pendants", "rings_bands", "rings_cocktail_rings", "rings_signet", "rings_stackable", "rise_high_rise", "rise_low_rise", "rise_mid_rise", "size_jumbo", "skirts_a_line", "skirts_asymmetric", "skirts_fluted", "skirts_pencil", "skirts_pleated", "skirts_slip", "skirts_tiered", "skirts_wrap", "sleepwear_sets", "sleeves_long_sleeved", "sleeves_puff_sleeve", "sleeves_short_sleeved", "sleeves_sleeveless", "sleeves_strapless", "strap_alligator", "strap_gold", "strap_leather", "strap_steel", "watches_rectangular", "watches_round", "watches_square")
• bag_families array nullable — Named bag lines (one of: "90_s", "agnes", "alma", "amalia", "amazona", "amazona_180", "andiamo", "astra", "audrey", "bamboo", "bang_bang", "barbara", "bilbao", "borsetto", "bracelet", "cabat", "campana", "cassandre", "cassette", "dionysus", "flamenco", "gaby", "gg_marmont", "giglio", "giorno", "hammock", "hop", "horsebit", "icare", "india", "jackie", "jamie", "jodie", "joya", "knot", "lauren", "le_37", "le_5_7", "le_city", "le_click", "le_coeur", "le_hip", "le_teckel", "loewe_font", "loop", "lotus", "loulou", "madison", "marcie", "marlo", "mercato", "mombasa", "n_s_park", "niki", "nodo", "notturno", "olivia", "ophidia", "paddington", "panier", "paparazzo", "parachute", "paris", "park", "paula_s_ibiza", "pebble", "peggy", "pinacoteca", "puzzle", "puzzle_fold", "rodeo", "sac_de_jour", "sardine", "slouchy_banana", "spin", "summer_banana", "terrasse", "uptown", "veneta", "voltaire", "wallace", "woody")
• badges array nullable — Merchandising badges (one of: "bestseller", "exclusive", "new_designer", "runway")
• sustainability array nullable — Sustainability credentials (one of: "designed_for_circularity", "lower_impact_materials", "responsible_craftsmanship")
• activities array nullable — Sport activities (one of: "golf", "gym_and_cross_train", "outdoor", "post_workout", "run", "ski", "tennis", "yoga_and_dance")
• personalisation array nullable — Personalised jewelry types (one of: "birthstone", "initials", "one_of_a_kind", "zodiac")
• count integer required — Max number of products to return (min: 1; max: 5000)
• query string required — Search keywords (examples: "dress", "gucci loafers"; minLength: 1)

Response

• @type string (default: "NetaporterProductCard")
• id string required
• catalog_id string nullable
• model_id string nullable
• manufacturer_code string nullable
• name string nullable
• name_en string nullable
• designer string nullable
• designer_id string nullable
• url string nullable
• price object nullable
  • @type string (default: "NetaporterPrice")
  • currency string nullable
  • currency_symbol string nullable
  • price number nullable
  • original_price number nullable
  • discount_percent number nullable
  • price_rounded number nullable
  • original_price_rounded number nullable
  • is_from_price boolean nullable
• color string nullable
• color_code string nullable
• legacy_id string nullable
• is_buyable boolean nullable
• is_visible boolean nullable
• is_displayable boolean nullable
• is_on_sale boolean nullable
• is_final_sale boolean nullable
• is_promo boolean nullable
• is_not_stocked_online boolean nullable
• has_other_colors boolean nullable
• image string nullable
• images array (default: [])
• badges array (default: [])
  • @type string (default: "NetaporterBadge-Output")
  • code string required
  • label string nullable
  • badge_type string nullable
• categories array (default: [])
  • @type string (default: "NetaporterCategoryRef")
  • id string required
  • code string nullable
  • name string nullable
  • path string nullable
• attributes array (default: [])
  • @type string (default: "NetaporterAttribute")
  • name string required
  • values array (default: [])

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.