{"_id":"544a4c20778b3e08002b2318","project":"543d1e263a300f20000d31fb","category":{"_id":"544a0a9727b7fc140078da58","__v":5,"pages":["544a43c0778b3e08002b2300","544a456827b7fc140078daf2","544a4c20778b3e08002b2318","544a4e0a778b3e08002b2327","544a4e2b778b3e08002b232b"],"version":"543d1e5e5276641a00a593cf","project":"543d1e263a300f20000d31fb","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-24T08:15:19.784Z","from_sync":false,"order":4,"slug":"store","title":"Store"},"editedParams":true,"parentDoc":null,"editedParams2":true,"__v":1,"user":"54352decadf50e0800b89024","is_link":false,"version":{"_id":"543d1e5e5276641a00a593cf","forked_from":"543d1e263a300f20000d31fe","project":"543d1e263a300f20000d31fb","__v":16,"createdAt":"2014-10-14T13:00:14.946Z","releaseDate":"2014-10-14T13:00:14.946Z","categories":["543d1e5f5276641a00a593d0","543d1ee45276641a00a593da","5448e2cbc64edd1a00453c29","5449135acdc944220048845c","544a0a93778b3e08002b2289","544a0a9727b7fc140078da58","544a456f27b7fc140078daff","544e027cbd51b9080037f680","544e029ab80812080035bba6","544e3a2eb80812080035bd67","5450b7c5a66f020800dba7b3","5450c0e47abbbc0800a5e989","5450c0f97abbbc0800a5e98a","5450c103a66f020800dba819","54f99f588d09b7390007ea45","565c81dbf3e9360d00823e43"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-24T12:54:56.169Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"method":"get","results":{"codes":[{"name":"","code":"[\n    {\n        \"id\": \"da04hJm\",\n        \"ern\": \"ern:store:da04hJm\",\n        \"street\": \"Vallensb\\u00e6k Stat.Torv 82\",\n        \"city\": \"Vallensb\\u00e6k Strand\",\n        \"zip_code\": \"2665\",\n        \"country\": {\n            \"id\": \"DK\",\n            \"unsubscribe_print_url\": \"http://on.fb.me/1x011u4\"\n        },\n        \"latitude\": 55.622803,\n        \"longitude\": 12.388037,\n        \"dealer_url\": \"https://api.etilbudsavis.dk/v2/dealers/9ba51\",\n        \"dealer_id\": \"9ba51\",\n        \"branding\": {\n            \"name\": \"Netto\",\n            \"url_name\": \"netto\",\n            \"website\": \"http://netto.dk/\",\n            \"logo\": \"https://cdn.eta.dk/img/logo/9ba51_4xgm5lcsa.png\",\n            \"logo_background\": \"ffdf00\",\n            \"color\": \"ffdf00\",\n            \"pageflip\": {\n                \"logo\": \"https://cdn.eta.dk/img/logo/9ba51_57fmptrl7.png\",\n                \"color\": \"ffdf00\"\n            }\n        },\n        \"contact\": null,\n        \"category_ids\": [\"supermarket\", \"discount\", \"groceries\"]\n    }\n  \t/* ..... */\n]","language":"json","status":200},{"name":"","code":"{\n    /* If your input is invalid, the error will be described in the returned json */\n}","language":"json","status":400}]},"try":true,"auth":"never","params":[{"_id":"544a4c20778b3e08002b2323","ref":"","in":"query","required":true,"desc":"Your API session token.","default":"","type":"string","name":"_token"},{"_id":"544a4c20778b3e08002b2322","ref":"","in":"query","required":false,"desc":"Your API session signature.","default":"","type":"string","name":"_signature"},{"_id":"544a4c20778b3e08002b2321","ref":"","in":"query","required":false,"desc":"Request latitude.","default":"","type":"double","name":"r_lat"},{"_id":"544a4c20778b3e08002b2320","ref":"","in":"query","required":false,"desc":"Request longitude.","default":"","type":"double","name":"r_lng"},{"_id":"544a4c20778b3e08002b231f","ref":"","in":"query","required":false,"desc":"Max distance to stores in meters.","default":"","type":"double","name":"r_radius"},{"_id":"544a4c20778b3e08002b231e","ref":"","in":"query","required":false,"desc":"Result set offset. Used for pagination.","default":"","type":"int","name":"offset"},{"_id":"544a4c20778b3e08002b231d","ref":"","in":"query","required":false,"desc":"Result set page max size.","default":"","type":"int","name":"limit"},{"_id":"544a4c8f778b3e08002b2325","ref":"","in":"query","required":true,"desc":"Plaintext store search query.","default":"","type":"string","name":"query"},{"_id":"544a4c20778b3e08002b231c","ref":"","in":"query","required":false,"desc":"Comma-seperated list of dealer ids to filter by.","default":"","type":"string","name":"dealer_ids"},{"_id":"544a4c20778b3e08002b231b","ref":"","in":"query","required":false,"desc":"Comma-seperated list of catalog ids to filter by.","default":"","type":"string","name":"catalog_ids"},{"_id":"544a4c20778b3e08002b231a","ref":"","in":"query","required":false,"desc":"Comma-seperated list of offer ids to filter by.","default":"","type":"string","name":"offer_ids"},{"_id":"544a4c20778b3e08002b2319","ref":"","in":"query","required":false,"desc":"Comma-seperated list of ordering instructions. See below for options.","default":"","type":"string","name":"order_by"}],"url":"/v2/stores/search"},"isReference":false,"order":2,"body":"Search in stores.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Order By\"\n}\n[/block]\nThe default ordering is by how well the search matched a store.\nThis is usually what you want.\n\nIf not, the available ordering options are:\n\n- created\n- dealer\n- score\n- distance\n\nSee the [Order By](doc:order-by) guide in the left sidebar for how to format `order_by` strings.","excerpt":"","slug":"store-search","type":"endpoint","title":"Store Search"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

_token:
required
string
Your API session token.
_signature:
string
Your API session signature.
r_lat:
double
Request latitude.
r_lng:
double
Request longitude.
r_radius:
double
Max distance to stores in meters.
offset:
integer
Result set offset. Used for pagination.
limit:
integer
Result set page max size.
query:
required
string
Plaintext store search query.
dealer_ids:
string
Comma-seperated list of dealer ids to filter by.
catalog_ids:
string
Comma-seperated list of catalog ids to filter by.
offer_ids:
string
Comma-seperated list of offer ids to filter by.
order_by:
string
Comma-seperated list of ordering instructions. See below for options.

Result Format


Documentation

Search in stores. [block:api-header] { "type": "basic", "title": "Order By" } [/block] The default ordering is by how well the search matched a store. This is usually what you want. If not, the available ordering options are: - created - dealer - score - distance See the [Order By](doc:order-by) guide in the left sidebar for how to format `order_by` strings.