{"_id":"544a1cfe778b3e08002b22b6","parentDoc":null,"editedParams2":true,"is_link":false,"editedParams":true,"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"},"project":"543d1e263a300f20000d31fb","user":"54352decadf50e0800b89024","__v":0,"category":{"_id":"544a0a93778b3e08002b2289","pages":["544a0c5d778b3e08002b2291","544a0c9727b7fc140078da5f","544a1cfe778b3e08002b22b6","544a20d927b7fc140078daac","544a2316778b3e08002b22d1","544a2ffd27b7fc140078dac8","544a342927b7fc140078dad0"],"version":"543d1e5e5276641a00a593cf","project":"543d1e263a300f20000d31fb","__v":7,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-24T08:15:15.030Z","from_sync":false,"order":5,"slug":"offer","title":"Offer"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-24T09:33:50.921Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"method":"get","results":{"codes":[{"status":200,"name":"","code":"[\n  {\n      \"id\": \"2acbeVU1\",\n      \"ern\": \"ern:offer:2acbeVU1\",\n      \"heading\": \"Coca-cola, Zero, light eller Fanta Exotic\",\n      \"description\": \"Ex. pant. 1,5 LITER. 6,67 pr. liter\",\n      \"catalog_page\": 24,\n      \"pricing\": {\n          \"price\": 10,\n          \"pre_price\": 12,\n          \"currency\": \"DKK\"\n      },\n      \"quantity\": {\n          \"unit\": {\n              \"symbol\": \"l\",\n              \"si\": {\n                  \"symbol\": \"l\",\n                  \"factor\": 1\n              }\n          },\n          \"size\": {\n              \"from\": 1.5,\n              \"to\": 1.5\n          },\n          \"pieces\": {\n              \"from\": 1,\n              \"to\": 1\n          }\n      },\n      \"images\": {\n          \"view\": \"https://cdn.eta.dk/img/offer/view/2acbeVU1.jpg\",\n          \"zoom\": \"https://cdn.eta.dk/img/offer/zoom/2acbeVU1.jpg\",\n          \"thumb\": \"https://cdn.eta.dk/img/offer/thumb/2acbeVU1.png\"\n      },\n      \"links\": {\n          \"webshop\": null\n      },\n      \"run_from\": \"2014-10-22T22:00:00+0000\",\n      \"run_till\": \"2014-10-25T21:59:59+0000\",\n      \"dealer_url\": \"https://api.etilbudsavis.dk/v2/dealers/11deC\",\n      \"store_url\": \"https://api.etilbudsavis.dk/v2/stores/de40Oig\",\n      \"catalog_url\": \"https://api.etilbudsavis.dk/v2/catalogs/9926veL\",\n      \"dealer_id\": \"11deC\",\n      \"store_id\": \"de40Oig\",\n      \"catalog_id\": \"9926veL\",\n      \"category_ids\": [\"supermarket\", \"discount\", \"groceries\"],\n      \"branding\": {\n          \"name\": \"REMA 1000\",\n          \"url_name\": \"rema-1000\",\n          \"website\": \"http://rema1000.dk\",\n          \"logo\": \"https://cdn.eta.dk/img/logo/5i2mwv2vp.png\",\n          \"logo_background\": \"034899\",\n          \"color\": \"034899\",\n          \"pageflip\": {\n              \"logo\": \"https://cdn.eta.dk/img/logo/6rtmwv30d.png\",\n              \"color\": \"034899\"\n          }\n      }\n  }\n  /* ..... */\n]","language":"json"},{"language":"json","status":400,"name":"","code":"{\n\t/* Expect bad requests for malformed input data. */\n}"}]},"try":true,"auth":"never","params":[{"_id":"544a1cfe778b3e08002b22c2","ref":"","in":"query","required":true,"desc":"Your API Session token.","default":"","type":"string","name":"_token"},{"_id":"544a1cfe778b3e08002b22c1","ref":"","in":"query","required":false,"desc":"Your API Session signature.","default":"","type":"string","name":"_signature"},{"_id":"544a1cfe778b3e08002b22c0","ref":"","in":"query","required":true,"desc":"Search query string.","default":"","type":"string","name":"query"},{"_id":"544a1cfe778b3e08002b22bf","ref":"","in":"query","required":false,"desc":"Request latitude.","default":"","type":"string","name":"r_lat"},{"_id":"544a1cfe778b3e08002b22be","ref":"","in":"query","required":false,"desc":"Request longitude.","default":"","type":"string","name":"r_lng"},{"_id":"544a1cfe778b3e08002b22bd","ref":"","in":"query","required":false,"desc":"Max distance to offers in meters.","default":"","type":"string","name":"r_radius"},{"_id":"544a1cfe778b3e08002b22bc","ref":"","in":"query","required":false,"desc":"Result set offset. Used for pagination.","default":"0","type":"string","name":"offset"},{"_id":"544a1cfe778b3e08002b22bb","ref":"","in":"query","required":false,"desc":"Result set max size.","default":"24","type":"string","name":"limit"},{"_id":"544a1cfe778b3e08002b22ba","ref":"","in":"query","required":false,"desc":"Comma-seperated list of store ids to filter by.","default":"","type":"string","name":"store_ids"},{"_id":"544a1cfe778b3e08002b22b9","ref":"","in":"query","required":false,"desc":"Comma-seperated list of catalog ids to filter by.","default":"","type":"string","name":"catalog_ids"},{"_id":"544a1cfe778b3e08002b22b8","ref":"","in":"query","required":false,"desc":"Comma-seperated list of dealer ids to filter by.","default":"","type":"string","name":"dealer_ids"},{"_id":"544a1cfe778b3e08002b22b7","ref":"","in":"query","required":false,"desc":"The ordering. We recommend leaving it at the default when searching.","default":"-score,-created","type":"string","name":"order_by"}],"url":"/v2/offers/search"},"isReference":false,"order":2,"body":"Search offers by query string.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Order By\"\n}\n[/block]\nResults are by default sorted by how well they match the query.\nIf you need to overide this, ordering options are:\n\n- popularity\n- page\n- created\n- price\n- quantity\n- count\n- expiration_date\n- publication_date\n- valid_date\n- dealer\n- score\n- distance\n- savings\n\nSee [Order By](doc:order-by) guide in left sidebar for information on how to use the `order_by` argument.","excerpt":"","slug":"offer-search","type":"endpoint","title":"Offer Search"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

_token:
required
string
Your API Session token.
_signature:
string
Your API Session signature.
query:
required
string
Search query string.
r_lat:
string
Request latitude.
r_lng:
string
Request longitude.
r_radius:
string
Max distance to offers in meters.
offset:
string0
Result set offset. Used for pagination.
limit:
string24
Result set max size.
store_ids:
string
Comma-seperated list of store ids to filter by.
catalog_ids:
string
Comma-seperated list of catalog ids to filter by.
dealer_ids:
string
Comma-seperated list of dealer ids to filter by.
order_by:
string-score,-created
The ordering. We recommend leaving it at the default when searching.

Result Format


Documentation

Search offers by query string. [block:api-header] { "type": "basic", "title": "Order By" } [/block] Results are by default sorted by how well they match the query. If you need to overide this, ordering options are: - popularity - page - created - price - quantity - count - expiration_date - publication_date - valid_date - dealer - score - distance - savings See [Order By](doc:order-by) guide in left sidebar for information on how to use the `order_by` argument.