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 behavior.

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 <= 100 characters 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

	entityCollectionParameters (object) or typedEntityCollectionParameters (object) Parameters for specifying which results to retrieve.
	entityCollectionParameters (object) or typedEntityCollectionParameters (object) Parameters for specifying which related results to retrieve.
	object (queryCollectionParameters) Parameters for specifying which spelling suggestions to retrieve.
	object (queryCollectionParameters) Parameters for specifying which related queries to retrieve.
	Array of objects (typedEntityCollectionParameters) <= 20 characters Parameters for specifying which content results to retrieve. This is a separate option from ResultsOptions and only applies to Content Search. One entry per content type to search, e.g. "Brand" or "Article", each with its own Take, Skip, and other parameters. There is no default: if empty, no content results are retrieved for any type. However, to prevent overly large responses, you can request at most 20 content types. Each entity type can be requested only once. The total take of all entries is at most 5000, the same as for a single results option. If content search fails for an entry, that entry is skipped and the regular results are still returned.
query required	string <= 300 characters The query used for searching in the request.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"resultsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
}
},
"relatedResultsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
}
},
"spellingSuggestionsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "popularity",
"order": "asc"
}
]
},
"relatedQueriesOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "popularity",
"order": "asc"
}
]
},
"contentResultsOptions": [{"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
},
"entityType": "Article"
}
],
"query": "forest fighting equipment",
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"makesSense": true,
"spellingSuggestions": {"count": 100,
"items": [{"query": "forest fighting equipment"
}
]
},
"relatedQueries": {"count": 100,
"items": [{"query": "forest fighting equipment"
}
]
},
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
},
"relatedResults": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
},
"redirect": "string",
"contentSearchResults": [{"entityType": "string",
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
}
}
]
}

Perform a 'Suggest' request

Used for performing 'Suggest' requests to the engine.

header Parameters

Api-Version required	string Example: V3 What version of the API to use.
User-Id required	string <= 100 characters 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

	object (queryCollectionParameters) Parameters for specifying which query suggestions to retrieve.
useTopSuggestionForSearch	boolean Default: true When 'true', the search may run against the top suggested autocompletion for the input query. The response always returns both 'OriginalQuery' and 'QueryUsedForSearch'. If 'QueryUsedForSearch' differs from 'OriginalQuery', it has been adjusted.
	entityCollectionParameters (object) or typedEntityCollectionParameters (object) Parameters for specifying which search results to retrieve.
	Array of objects (typedEntityCollectionParameters) <= 20 characters Parameters for specifying which content results to retrieve. This is a separate option from ResultsOptions and only applies to Content Search. One entry per content type to search, e.g. "Brand" or "Article", each with its own Take, Skip, and other parameters. There is no default: if empty, no content results are retrieved for any type. However, to prevent overly large responses, you can request at most 20 content types. Each entity type can be requested only once. The total take of all entries is at most 5000, the same as for a single results option. If content search fails for an entry, that entry is skipped and the regular results are still returned.
query required	string <= 300 characters The query used for searching in the request.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"queriesOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "popularity",
"order": "asc"
}
]
},
"useTopSuggestionForSearch": true,
"resultsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
}
},
"contentResultsOptions": [{"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
},
"entityType": "Article"
}
],
"query": "forest fighting equipment",
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"makesSense": true,
"originalQuery": "chi",
"queryUsedForSearch": "chicken",
"scopedQuery": {"query": "forest fighting equipment"
},
"queries": {"count": 100,
"items": [{"query": "forest fighting equipment"
}
]
},
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
},
"contentSearchResults": [{"entityType": "string",
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
}
}
]
}

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 <= 100 characters 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

	object (queryCollectionParameters) Parameters for specifying which query suggestions to retrieve.
query required	string <= 300 characters The query used for searching in the request.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"queriesOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "popularity",
"order": "asc"
}
]
},
"query": "forest fighting equipment",
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"scopedQuery": {"query": "forest fighting equipment"
},
"queries": {"count": 100,
"items": [{"query": "forest fighting equipment"
}
]
}
}

Create behavior events

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

header Parameters

Api-Version required	string Example: V3 What version of the API to use.
User-Id required	string <= 100 characters 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

required	Array of objects (event) Array of events submitted to the engine.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"events": [{"type": "purchase",
"entity": {"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
},
"revenue": 5,
"orderId": "66",
"quantity": 19
}
],
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

Example

response

{"customData": {"property1": "string",
"property2": "string"
}
}

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 <= 100 characters 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

	entityCollectionParameters (object) or typedEntityCollectionParameters (object) Parameters for specifying which results to retrieve and how to format them.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"resultsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
}
},
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
}
}

Get Complementary entities

Used to perform a request to get entities that are complementary to a selected entity.

header Parameters

Api-Version required	string Example: V3 What version of the API to use.
User-Id required	string <= 100 characters 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

required	object (entity) The entity to find complementary entities to.
	entityCollectionParameters (object) or typedEntityCollectionParameters (object) Parameters for specifying which complementary results to retrieve and how to format them.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"entity": {"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
},
"resultsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
}
},
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
}
}

Get basket recommendations

Used to perform a request to get recommendations for a set of product ids.

header Parameters

Api-Version required	string Example: V3 What version of the API to use.
User-Id required	string <= 100 characters 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

required	Array of objects (entity) The entities to find recommendations for.
	entityCollectionParameters (object) or typedEntityCollectionParameters (object) Parameters for specifying which recommendations results to retrieve and how to format them.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"entities": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
],
"resultsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
}
},
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
}
}

Get recommendations

Used to perform a request to get personalized recommendations.

header Parameters

Api-Version required	string Example: V3 What version of the API to use.
User-Id required	string <= 100 characters 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

	entityCollectionParameters (object) or typedEntityCollectionParameters (object) Parameters for specifying which recommendations results to retrieve and how to format them.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"resultsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
}
},
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
}
}

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 <= 100 characters 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

required	object (entity) The entity to find related entities to.
	entityCollectionParameters (object) or typedEntityCollectionParameters (object) Parameters for specifying which related results to retrieve and how to format them.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"entity": {"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
},
"resultsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
}
},
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
}
}

Get popular entities

Used to perform a request to get entities that a user (or all users) most commonly interacted with or navigated to.

header Parameters

Api-Version required	string Example: V3 What version of the API to use.
User-Id required	string <= 100 characters 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

behaviorType required	string The interaction or navigation type to include (such as "click", "purchase" or "search").
entityType	Array of strings The entity types to include (such as "Product" or "Query") or null for all.
forUserId	string A user ID to retrieve the most common/recent entities for that user or null to retrieve the globally most common/recent entities. The literal "(CurrentUser)" can be specified to use the user ID from the User-Id request header.
	entityCollectionParameters (object) or typedEntityCollectionParameters (object) Parameters for specifying how to filter and sort the results.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"behaviorType": "string",
"entityType": ["string"
],
"forUserId": "string",
"resultsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
}
},
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
}
}

Get recent entities

Used to perform a request to get entities that a user (or all users) most recently interacted with or navigated to.

header Parameters

Api-Version required	string Example: V3 What version of the API to use.
User-Id required	string <= 100 characters 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

behaviorType required	string The interaction or navigation type to include (such as "click", "purchase" or "search").
entityType	Array of strings The entity types to include (such as "Product" or "Query") or null for all.
forUserId	string A user ID to retrieve the most common/recent entities for that user or null to retrieve the globally most common/recent entities. The literal "(CurrentUser)" can be specified to use the user ID from the User-Id request header.
	entityCollectionParameters (object) or typedEntityCollectionParameters (object) Parameters for specifying how to filter and sort the results.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"behaviorType": "string",
"entityType": ["string"
],
"forUserId": "string",
"resultsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
}
},
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
}
}

Get entities by indexed attribute

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. To find out what values are available call /getIndexedAttributeValues.

header Parameters

Api-Version required	string Example: V3 What version of the API to use.
User-Id required	string <= 100 characters 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

required	object (gebaAttributeNameValuePair) The attribute name-value-pair to find entities connected to. Note: this attribute needs to be indexed in the engine. See the endpoint GetIndexedAttributes.
	entityCollectionParameters (object) or typedEntityCollectionParameters (object) Parameters for specifying which results to retrieve and how to format them.
	object (requestAliasFields) Provides human-readable labels in the Portal.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"attribute": {"name": "category",
"value": "AT walkers"
},
"resultsOptions": {"skip": 0,
"take": 42,
"sortBy": [{"type": "attribute",
"attributeName": "category",
"order": "asc"
}
],
"facets": [{"name": "categoryFacet",
"attributeName": "category",
"type": "distinct",
"selected": ["AT walkers"
],
"sortBy": [{"type": "item",
"order": "asc"
}
]
}
],
"filter": {"attributeName": "category"
}
},
"requestAlias": {"name": "Subcategory",
"value": "Armoured Cavalry",
"details": "Warfare > Vehicles > Armoured Cavalry"
},
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"results": {"count": 100,
"facets": [{"name": "categoryFacet",
"type": "distinct",
"approximated": true,
"items": [{"item": "AT walkers",
"count": 15,
"selected": true
}
]
}
],
"items": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
]
}
}

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

object

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

Responses

Request samples

Payload

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"attributes": ["category",
"brand",
"manufacturer",
"price",
"modified",
"numberinstock"
],
"indexedAttributes": ["category",
"brand",
"manufacturer"
]
}

Get indexed attribute values

Used to perform a request to get a list of all unique values that are indexed for the provided attribute. 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.
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

attributeName required	string The name of the attribute for which to fetch indexed values.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"attributeName": "category",
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"values": ["AT walkers",
"Protocol droids"
]
}

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

object

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

Responses

Request samples

Payload

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

Example

response

{"customData": {"property1": "string",
"property2": "string"
}
}

Perform partial catalog sync

Used to update the product catalog with new data, adding/removing/updating products.

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

	Array of objects (entity) If the entity exists, its attributes will be updated with data from supplied entity, otherwise it will be added. Entities without attributes are ignored.
	Array of objects (entity) If the entity exists, it will be completely replaced with supplied entity, otherwise it will be added. Entities without attributes are ignored.
	Array of objects (entity) If the entity exists, it will be removed, otherwise nothing happens.
	Array of objects (entity) If the entity exists and has the specified attribute, this attribute will be removed from it.
	object Any additional, non-standard, data. Contact support for information about how and when to use this.

Responses

Request samples

Payload

Content type

application/json

{"toAddOrUpdate": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
],
"toReplaceOrAdd": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
],
"toDelete": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
],
"toRemoveAttributesFrom": [{"type": "Product",
"id": "MSE-6",
"attributes": [{"name": "title",
"type": "string",
"values": ["MSE-6-series repair droid"
]
}
]
}
],
"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

Example

response

{"customData": {"property1": "string",
"property2": "string"
}
}

Get sync state

Returns the current sync state, including the most recently applied and failed catalog updates.

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

object

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

Responses

Request samples

Payload

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
},
"latestSuccess": {"appliedAtUtc": "string",
"earliestChangeFromUtc": "string",
"changedOrAddedCount": 0,
"removedCount": 0
},
"latestFailure": {"failedAtUtc": "string",
"failedEventCount": 0
},
"inProgress": [{"startedAtUtc": "string",
"origin": "unknown",
"state": "receivingData"
}
],
"inProgressCount": 0
}

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

object

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

Responses

Request samples

Payload

Content type

application/json

{"customData": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
404
500

Content type

application/json

Example

response

{"customData": {"property1": "string",
"property2": "string"
}
}