s1 API Host

<back to all web services

GetProductsRequest

The following routes are available for this service:
GET, OPTIONS/api/productsSearch for products by search term or a list of ean codes.User has to be authenticated to search for products.
Parameters:
NameParameterData TypeRequiredDescription
SearchTermquerystringNoThe search string.
EanCodesquerystringNoA list of comma seperated ean codes.
IsSimpleKeywordSearchqueryboolNoSimple keyword search yes or no.
SkipqueryintNoThe amount of search results that need to be skipped. Default value is 0.
TakequeryintNoThe amount of search results that need to be taken. Default value is 25.
SortKeyquerystringNoThe key on which the sort needs to be applied. There is no default sorting applied.
SortDirectionquerystringNoThe direction in which the sorting needs to be applied. SortKey is a required field if you use this parameter. There is no default sort direction applied.
IncludeFilterOptionsqueryboolNoDefault is false. If set to true, will return the filter options for the given products.
IncludeAssetsqueryboolNoDefault is false. If set to true, will return extra assets for the given products.
WithoutRouteInfoqueryboolNoIf set to true, will not return route info which will decrease response times.
WithoutNettoPricequeryboolNoIf set to true, will not return net prices which will decrease response times.

To override the Content-type in your clients HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/GetProductsRequest HTTP/1.1 
Host: api-beta.ghs-automotive.nl 
Content-Type: text/csv
Content-Length: length

SearchTerm,EanCodes,IsSimpleKeywordSearch,Skip,Take,SortKey,SortDirection,IncludeFilterOptions,IncludeAssets,WithoutRouteInfo,WithoutNettoPrice
String,,False,0,0,String,String,False,False,False,False

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

ResponseStatus,UrgentMessages,TotalResults,IsTruncated,Products,Assets,SpecialToolProducts,FilterOptions,DebugInfo
"{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}",,0,False,,,,,{totalDuration:0}