Loop54 Engine (V3)

Download OpenAPI specification:Download

Loop54 Search is a learning search engine for e-commerce. It helps online shoppers find what they’re looking for, and allows them to explore a wider range of relevant products in a retailer’s catalogue.

User initiated

Operations for getting products, or other entities, and to collect user behaviour.

Perform a search request

Used for performing search requests to the engine.

header Parameters
Api-Version
required
string
Example: "V3"

What version of the API to use.

User-Id
required
string
Example: "Luke.Skywalker"

A unique identifier of the end user that initiated the action.

User-Ip
string
Example: "127.0.0.1"

The IP address of the end user.

User-Useragent
string
Example: "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"

The User-Agent header sent by the end user.

User-Referer
string
Example: "https://www.loop54.com/docs"

The referer header sent by the end user.

Lib-Version
string
Example: "js:2018-01-01"

What library is used to generate this request.

Loop54-key
string
Example: "9cdfb439c7876e703e307864c9167a15"

Your API key.

Request Body schema: application/json
query
required
string <= 200 characters

The query to search for.

resultsOptions
object

Parameters for specifying which results to retrieve.

relatedResultsOptions
object

Parameters for specifying which related results to retrieve.

spellingSuggestionsOptions
object

Parameters for specifying which spelling suggestions to retrieve.

relatedQueriesOptions
object

Parameters for specifying which related queries to retrieve.

customData
object

Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

200

Successful method call.

400

Bad request. Please check the parameters and content of your request.

401

You're not authorized to view this content or perform this action.

404

The resource could not be found.

500

Internal server error. Something very bad happened.

post /search
https://[clientId].54proxy.[region]/search

Request samples

application/json
Copy
Expand all Collapse all
{
  • "query": "forest fighting equipment",
  • "resultsOptions":
    {
    },
  • "relatedResultsOptions":
    {
    },
  • "spellingSuggestionsOptions":
    {
    },
  • "relatedQueriesOptions":
    {
    },
  • "customData":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "customData":
    {
    },
  • "makesSense": true,
  • "spellingSuggestions":
    {
    },
  • "relatedQueries":
    {
    },
  • "results":
    {
    },
  • "relatedResults":
    {
    }
}

Find autocompletions for a query

Used for performing autocomplete requests to the engine.

header Parameters
Api-Version
required
string
Example: "V3"

What version of the API to use.

User-Id
required
string
Example: "Luke.Skywalker"

A unique identifier of the end user that initiated the action.

User-Ip
string
Example: "127.0.0.1"

The IP address of the end user.

User-Useragent
string
Example: "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"

The User-Agent header sent by the end user.

User-Referer
string
Example: "https://www.loop54.com/docs"

The referer header sent by the end user.

Lib-Version
string
Example: "js:2018-01-01"

What library is used to generate this request.

Loop54-key
string
Example: "9cdfb439c7876e703e307864c9167a15"

Your API key.

Request Body schema: application/json
query
required
string

The query to find suggestions.

queriesOptions
object

Parameters for specifying which query suggestions to retrieve.

customData
object

Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

200

Successful method call.

400

Bad request. Please check the parameters and content of your request.

401

You're not authorized to view this content or perform this action.

404

The resource could not be found.

500

Internal server error. Something very bad happened.

post /autoComplete
https://[clientId].54proxy.[region]/autoComplete

Request samples

application/json
Copy
Expand all Collapse all
{
  • "query": "forest fighting equip",
  • "queriesOptions":
    {
    },
  • "customData":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "customData":
    {
    },
  • "scopedQuery":
    {
    },
  • "queries":
    {
    }
}

Create behaviour events

Used to signal the engine that the user has exhibited a behaviour.

header Parameters
Api-Version
required
string
Example: "V3"

What version of the API to use.

User-Id
required
string
Example: "Luke.Skywalker"

A unique identifier of the end user that initiated the action.

User-Ip
string
Example: "127.0.0.1"

The IP address of the end user.

User-Useragent
string
Example: "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"

The User-Agent header sent by the end user.

User-Referer
string
Example: "https://www.loop54.com/docs"

The referer header sent by the end user.

Lib-Version
string
Example: "js:2018-01-01"

What library is used to generate this request.

Loop54-key
string
Example: "9cdfb439c7876e703e307864c9167a15"

Your API key.

Request Body schema: application/json
events
required
Array of objects (event)

Parameters for specifying which query suggestions to retrieve.

customData
object

Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

200

Successful method call.

400

Bad request. Please check the parameters and content of your request.

401

You're not authorized to view this content or perform this action.

404

The resource could not be found.

500

Internal server error. Something very bad happened.

post /createEvents
https://[clientId].54proxy.[region]/createEvents

Request samples

application/json
Copy
Expand all Collapse all
{
  • "events":
    [
    ],
  • "customData":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "customData":
    {
    }
}

Get entities

Used to perform a request to get entities.

header Parameters
Api-Version
required
string
Example: "V3"

What version of the API to use.

User-Id
required
string
Example: "Luke.Skywalker"

A unique identifier of the end user that initiated the action.

User-Ip
string
Example: "127.0.0.1"

The IP address of the end user.

User-Useragent
string
Example: "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"

The User-Agent header sent by the end user.

User-Referer
string
Example: "https://www.loop54.com/docs"

The referer header sent by the end user.

Lib-Version
string
Example: "js:2018-01-01"

What library is used to generate this request.

Loop54-key
string
Example: "9cdfb439c7876e703e307864c9167a15"

Your API key.

Request Body schema: application/json
resultsOptions
object

Parameters for specifying which results to retrieve and how to format them.

customData
object

Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

200

Successful method call.

400

Bad request. Please check the parameters and content of your request.

401

You're not authorized to view this content or perform this action.

404

The resource could not be found.

500

Internal server error. Something very bad happened.

post /getEntities
https://[clientId].54proxy.[region]/getEntities

Request samples

application/json
Copy
Expand all Collapse all
{
  • "resultsOptions":
    {
    },
  • "customData":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "customData":
    {
    },
  • "results":
    {
    }
}

Get related entities

Used to perform a request to get entities related to a selected entity.

header Parameters
Api-Version
required
string
Example: "V3"

What version of the API to use.

User-Id
required
string
Example: "Luke.Skywalker"

A unique identifier of the end user that initiated the action.

User-Ip
string
Example: "127.0.0.1"

The IP address of the end user.

User-Useragent
string
Example: "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"

The User-Agent header sent by the end user.

User-Referer
string
Example: "https://www.loop54.com/docs"

The referer header sent by the end user.

Lib-Version
string
Example: "js:2018-01-01"

What library is used to generate this request.

Loop54-key
string
Example: "9cdfb439c7876e703e307864c9167a15"

Your API key.

Request Body schema: application/json
entity
required
object

The entity to find related entities to.

resultsOptions
object

Parameters for specifying which related results to retrieve and how to format them.

customData
object

Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

200

Successful method call.

400

Bad request. Please check the parameters and content of your request.

401

You're not authorized to view this content or perform this action.

404

The resource could not be found.

500

Internal server error. Something very bad happened.

post /getRelatedEntities
https://[clientId].54proxy.[region]/getRelatedEntities

Request samples

application/json
Copy
Expand all Collapse all
{
  • "entity":
    {
    },
  • "resultsOptions":
    {
    },
  • "customData":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "customData":
    {
    },
  • "results":
    {
    }
}

Get entities by indexed attrbute

Used to perform a request to get entities with an indexed string attribute. For attributes that are not indexed, use GetEntities with a filter instead. To find out what attributes are indexed in the engine call /getIndexedAttributes.

header Parameters
Api-Version
required
string
Example: "V3"

What version of the API to use.

User-Id
required
string
Example: "Luke.Skywalker"

A unique identifier of the end user that initiated the action.

User-Ip
string
Example: "127.0.0.1"

The IP address of the end user.

User-Useragent
string
Example: "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"

The User-Agent header sent by the end user.

User-Referer
string
Example: "https://www.loop54.com/docs"

The referer header sent by the end user.

Lib-Version
string
Example: "js:2018-01-01"

What library is used to generate this request.

Loop54-key
string
Example: "9cdfb439c7876e703e307864c9167a15"

Your API key.

Request Body schema: application/json
attribute
required
object

The attribute name-value-pair to find entities connected to. Note: this attribute needs to be indexed in the engine. See the endpoint GetIndexedAttributes.

resultsOptions
object

Parameters for specifying which results to retrieve and how to format them.

customData
object

Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

200

Successful method call.

400

Bad request. Please check the parameters and content of your request.

401

You're not authorized to view this content or perform this action.

404

The resource could not be found.

500

Internal server error. Something very bad happened.

post /getEntitiesByAttribute
https://[clientId].54proxy.[region]/getEntitiesByAttribute

Request samples

application/json
Copy
Expand all Collapse all
{
  • "attribute":
    {
    },
  • "resultsOptions":
    {
    },
  • "customData":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "customData":
    {
    },
  • "results":
    {
    }
}

Administrative

Operations for updating the indexed products

Get indexed attributes

Used to perform a request to get information about attributes, indexed and non-indexed.

header Parameters
Api-Version
required
string
Example: "V3"

What version of the API to use.

Loop54-key
required
string
Example: "9cdfb439c7876e703e307864c9167a15"

Your API key.

Lib-Version
string
Example: "js:2018-01-01"

What library is used to generate this request.

Request Body schema: application/json
customData
object

Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

200

Successful method call.

400

Bad request. Please check the parameters and content of your request.

401

You're not authorized to view this content or perform this action.

404

The resource could not be found.

500

Internal server error. Something very bad happened.

post /getIndexedAttributes
https://[clientId].54proxy.[region]/getIndexedAttributes

Request samples

application/json
Copy
Expand all Collapse all
{
  • "customData":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "customData":
    {
    },
  • "attributes":
    [
    ],
  • "indexedAttributes":
    [
    ]
}

Perform full sync

Used for telling the engine to re-sync the catalog.

header Parameters
Api-Version
required
string
Example: "V3"

What version of the API to use.

Loop54-key
required
string
Example: "9cdfb439c7876e703e307864c9167a15"

Your API key.

Lib-Version
string
Example: "js:2018-01-01"

What library is used to generate this request.

Request Body schema: application/json
customData
object

Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

200

Successful method call.

400

Bad request. Please check the parameters and content of your request.

401

You're not authorized to view this content or perform this action.

404

The resource could not be found.

500

Internal server error. Something very bad happened.

post /sync
https://[clientId].54proxy.[region]/sync

Request samples

application/json
Copy
Expand all Collapse all
{
  • "customData":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "customData":
    {
    }
}

Other

Custom Request

Used to trigger predefined client-specific actions.

path Parameters
requestName
required
string

Which action to trigger

header Parameters
Api-Version
required
string
Example: "V3"

What version of the API to use.

Loop54-key
required
string
Example: "9cdfb439c7876e703e307864c9167a15"

Your API key.

Lib-Version
string
Example: "js:2018-01-01"

What library is used to generate this request.

Request Body schema: application/json
customData
object

Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

200

Successful method call.

400

Bad request. Please check the parameters and content of your request.

401

You're not authorized to view this content or perform this action.

404

The resource could not be found.

500

Internal server error. Something very bad happened.

post /{requestName}
https://[clientId].54proxy.[region]/{requestName}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "customData":