Skip to main content
POST
Create

Authorizations

Authorization
string
header
default:Token <your_api_key>
required

Doofinder API key. The Token prefix is part of the header value, so enter it too — the field is sent verbatim as:

Body

application/json

A search engine groups a number of indices. Any search done to the search engine takes the best results of all indices beneath. Also, search engine options applies to all its indices.

locale
string
required

An ISO locale code is a standardized identifier combining language and region codes. The language part, usually a two-letter code, is from ISO 639-1, while the region part (optional, but recommended), often a two or three-letter code, is from ISO 3166-1. Determines the locale of the search engine. The locale affects how the words indexed are tokenized and which stopwords to use.

Example:

"es-ES"

name
string
required

A short name that helps identifying the search engine.

Example:

"My Search Engine"

store_id
string | null
required

The Store identifier.

Example:

"e9d6fcd2-0262-4094-bf3c-671ec5da5455"

currency
enum<string>
default:EUR

Currency used in the search engine in ISO 4217 Code

Available options:
AED,
ARS,
AUD,
BAM,
BDT,
BGN,
BOB,
BRL,
BYN,
CAD,
CHF,
CLP,
CNY,
COP,
CZK,
DKK,
DOP,
EGP,
EUR,
GBP,
HKD,
HRK,
HUF,
IDR,
ILS,
INR,
IRR,
ISK,
JPY,
KRW,
KWD,
MXN,
MYR,
NOK,
NZD,
PEN,
PLN,
RON,
RSD,
RUB,
SAR,
SEK,
TRY,
TWD,
UAH,
USD,
VEF,
VND,
XPF,
ZAR
Example:

"EUR"

language
enum<string> | null
deprecated

(DEPRECATED), use locale field instead. Curently it won't have any effect in the Search Engine.

Available options:
ar,
hy,
eu,
pt-br,
bg,
ca,
cs,
da,
nl,
en,
fi,
fr,
de,
el,
hi,
hu,
id,
it,
no,
pt,
ro,
ru,
es,
sv,
tr
Example:

"es"

stopwords
boolean
default:false

Ignores high-frequency terms like "the", "and", "is". These words have a low weight and contribute little to the relevance score.

Example:

false

default
boolean
default:false

Indicates if the search engine is the default one for the store.

Example:

false

platform
enum<string>
default:api

Indicates which platform the search engine is associated with.

Available options:
api,
shopify,
woocommerce,
bigcommerce,
crawler,
ecommerce,
ekm,
file,
magento,
magento2,
opencart,
oscommerce,
plentyone,
prestashop,
shoper,
shopware
Example:

"shopify"

has_grouping
boolean
default:false

When this option is selected, only one of the item variants is returned in the search results. This only works if the indexed item have the group_id field.

Response

Search engine created.

A search engine groups a number of indices. Any search done to the search engine takes the best results of all indices beneath. Also, search engine options applies to all its indices.

name
string
required

A short name that helps identifying the search engine.

Example:

"My Search Engine"

currency
enum<string>
default:EUR

Currency used in the search engine in ISO 4217 Code

Available options:
AED,
ARS,
AUD,
BAM,
BDT,
BGN,
BOB,
BRL,
BYN,
CAD,
CHF,
CLP,
CNY,
COP,
CZK,
DKK,
DOP,
EGP,
EUR,
GBP,
HKD,
HRK,
HUF,
IDR,
ILS,
INR,
IRR,
ISK,
JPY,
KRW,
KWD,
MXN,
MYR,
NOK,
NZD,
PEN,
PLN,
RON,
RSD,
RUB,
SAR,
SEK,
TRY,
TWD,
UAH,
USD,
VEF,
VND,
XPF,
ZAR
Example:

"EUR"

hashid
string
read-only

A unique code that identifies a search engine.

Example:

"123456789012345678901234567890ab"

indices
Index · object[]
read-only

A list of indices for a search engine.

status
enum<string>
read-only

Indicates the current status of the search engine.

Available options:
active,
inactive
Example:

"active"

language
enum<string> | null
deprecated

(DEPRECATED), use locale field instead. Curently it won't have any effect in the Search Engine.

Available options:
ar,
hy,
eu,
pt-br,
bg,
ca,
cs,
da,
nl,
en,
fi,
fr,
de,
el,
hi,
hu,
id,
it,
no,
pt,
ro,
ru,
es,
sv,
tr
Example:

"es"

locale
string

An ISO locale code is a standardized identifier combining language and region codes. The language part, usually a two-letter code, is from ISO 639-1, while the region part (optional, but recommended), often a two or three-letter code, is from ISO 3166-1. Determines the locale of the search engine. The locale affects how the words indexed are tokenized and which stopwords to use.

Example:

"es-ES"

search_url
string<uri>
read-only

Indicates the search server domain for this search engine. You should use this domain to perform searches to this search engine.

Example:

"https://eu1-search.doofinder.com"

stopwords
boolean
default:false

Ignores high-frequency terms like "the", "and", "is". These words have a low weight and contribute little to the relevance score.

Example:

false

default
boolean
default:false

Indicates if the search engine is the default one for the store.

Example:

false

platform
enum<string>
default:api

Indicates which platform the search engine is associated with.

Available options:
api,
shopify,
woocommerce,
bigcommerce,
crawler,
ecommerce,
ekm,
file,
magento,
magento2,
opencart,
oscommerce,
plentyone,
prestashop,
shoper,
shopware
Example:

"shopify"

has_grouping
boolean
default:false

When this option is selected, only one of the item variants is returned in the search results. This only works if the indexed item have the group_id field.

store_id
string | null

The Store identifier.

Example:

"e9d6fcd2-0262-4094-bf3c-671ec5da5455"