/
Search REST API: Skusearch

Search REST API: Skusearch

Jul 10, 2019

Overview

The purpose of this guide is to provide the necessary info in order to use the "skusearch" endpoint of the Search service. 

The main goal of this endpoint is to provide a set of parameters with the aim of searching SKUs (Stock keeping units) mainly using:

  • A product identifier field (SkuField) that can be updated by configuration (its value is specified using the "q" parameter of the request)

Service URL

URL_SEARCH/INSTANCE_ID/skusearch?INPUT_PARAMETERS

URI Parameters

Parameter name

Description

Type

Mandatory

Parameter name

Description

Type

Mandatory

q

The product identifier value being requested

String

lang

The language used by the request

String

store

The store identifier used by the request (Part of the uri params specified by config)

String

warehouse

The warehouse identifier used by the request (Part of the uri params specified by config)

String

catalogue

The catalogue identifier used by the request (Part of the uri params specified by config)

String

start

The number of results to be omitted from the start of the result set (search pagination)

Integer

rows

The number of results to return (search pagination)

Integer

origin

The origin of the request

String

*If additional params are required, please contact us

Output

SKU search results

The service will return a single json node per product/document and all attributes associated with the item type

skusearch output
"content": { "docs": [{ "id": "500975676", "eb_id": "500975676-009", "internal_id": "500975676-009", "mocacoReference": "1628/311/009", "eb_sku": "1628/311/009", "minPrice": "19.99", "maxPrice": "19.99", "minOldPrice": "0.0", "maxOldPrice": "0.0", "name": "Sandalia azul tacón medio pulsera", "firstRootCategory": "1010141507", "idProduct": "500975676-009", "productId": "500975676", "reference": "1628/311", "displayReference": "1628/311", "img": { "timestamp": "1537979412849", "url": "/2018/I/1/1/p/1628/311/009/1628311009", "aux": [ "1", "2", "3", "4", "5", "6" ], "type": [ "1", "2", "3", "4" ] } } ], "numFound": 1 }

Related articles