{"_id":"543d213b5276641a00a593f6","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"},"__v":1,"editedParams2":true,"user":"54352decadf50e0800b89024","project":"543d1e263a300f20000d31fb","is_link":false,"category":{"_id":"5448e2cbc64edd1a00453c29","version":"543d1e5e5276641a00a593cf","__v":4,"pages":["5448db04c64edd1a00453c17","543d213b5276641a00a593f6","5449059c3acc37080099e643","5448e105c64edd1a00453c23","5448ddd77018ed1400f60754","5448eee6cdc9442200488400","5448ef5dcdc9442200488404","54b91f7ac875cb0c00c36481"],"project":"543d1e263a300f20000d31fb","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-23T11:13:15.517Z","from_sync":false,"order":3,"slug":"catalog","title":"Catalog"},"editedParams":true,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-14T13:12:27.120Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"method":"get","results":{"codes":[{"name":"Success","code":"[\n  {\n    \"id\": \"28f5WeL\",\n    \"ern\": \"ern:catalog:28f5WeL\",\n    \"label\": null,\n    \"background\": null,\n    \"run_from\": \"2014-10-10T22:00:00+0000\",\n    \"run_till\": \"2014-10-24T21:59:59+0000\",\n    \"page_count\": 40,\n    \"offer_count\": 447,\n    \"branding\": {\n        \"name\": \"BAUHAUS\",\n        \"url_name\": \"bauhaus\",\n        \"website\": \"http://bauhaus.dk\",\n        \"logo\": \"https://cdn.net/fcf0x_382m5lbbe.png\",\n        \"logo_background\": null,\n        \"color\": \"ee1720\",\n        \"pageflip\": {\n            \"logo\": \"https://cdn.net/fcf0x_7flm5lbbe.png\",\n            \"color\": \"ee1720\"\n        }\n    },\n    \"dealer_id\": \"fcf0x\",\n    \"dealer_url\": \"https://api.eta.dk/v2/dealers/fcf0x\",\n    \"store_id\": \"f2686w\",\n    \"store_url\": \"https://api.eta.dk/v2/stores/f2686w\",\n    \"dimensions\": {\n        \"height\": 1.3255722372631,\n        \"width\": 1\n    },\n  \t\"images\": {\n        \"thumb\": \"https://cdn.net/28f5WeL-1.jpg\",\n        \"view\": \"https://cdn.net/28f5WeL-1.jpg\",\n        \"zoom\": \"https://cdn.net/28f5WeL-1.jpg\"\n    },\n    \"category_ids\": [\"home-improvement\", \"home-garden\"],\n    \"pdf_url\": null\n  }\n  /* more like the above object */\n]","language":"json","status":200},{"name":"Failure","code":"{\n    \"code\": 0000, // Error code unique to the issue\n    \"id\": \"00i199n6zi35phhr924k2nyntuiy8xdg\", // Unique error id. You can give this to support.\n    \"message\": \"message about your specific issue\",\n    \"details\": \"More general description of that error type\",\n    \"previous\": {} // Object describing issues leading up to this error\n}","language":"json","status":400}]},"try":true,"auth":"never","params":[{"_id":"543d213b5276641a00a593fa","ref":"","in":"query","required":true,"desc":"The API session token.","default":"","type":"string","name":"_token"},{"_id":"543d213b5276641a00a593f9","ref":"","in":"query","required":false,"desc":"The session signature, verifying your session. This is not required from a website.","default":"","type":"string","name":"_signature"},{"_id":"543d213b5276641a00a593f8","ref":"","in":"query","required":false,"desc":"Results per response.","default":"24","type":"int","name":"limit"},{"_id":"543d213b5276641a00a593f7","ref":"","in":"query","required":false,"desc":"Resultset offset. Used for pagination.","default":"0","type":"int","name":"offset"},{"_id":"543d2904a10ab32000b3aa43","ref":"","in":"query","required":false,"desc":"Request latitude.","default":"","type":"double","name":"r_lat"},{"_id":"543d2904a10ab32000b3aa42","ref":"","in":"query","required":false,"desc":"Request longitude.","default":"","type":"double","name":"r_lng"},{"_id":"543d2904a10ab32000b3aa41","ref":"","in":"query","required":false,"desc":"Limit content to this radius (in meters).","default":"","type":"double","name":"r_radius"},{"_id":"543d2904a10ab32000b3aa40","ref":"","in":"query","required":false,"desc":"Resultset order.","default":"-popularity,-created","type":"string","name":"order_by"},{"_id":"543d2904a10ab32000b3aa3f","ref":"","in":"query","required":false,"desc":"Comma-seperated list of dealer ids. The result will be limted to catalogs matching this filter.","default":"","type":"string","name":"dealer_ids"},{"_id":"543d2904a10ab32000b3aa3e","ref":"","in":"query","required":false,"desc":"Comma-seperated list of store ids. The result will be limted to catalogs matching this filter.","default":"","type":"string","name":"store_ids"},{"_id":"543d2904a10ab32000b3aa3d","ref":"","in":"query","required":false,"desc":"Comma-seperated list of catalog ids. The result will be limted to catalogs matching this filter.","default":"","type":"string","name":"catalog_ids"}],"url":"/v2/catalogs"},"isReference":false,"order":1,"body":"This endpoint retrieves a list of publicly accessible catalogs.\nWhen you need a list of catalogs, this is most likely the endpoint you will need.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Order By\"\n}\n[/block]\nThe available orderings are;\n\n- popularity\n- created\n- expiration_date\n- publication_date\n- valid_date\n- dealer\n- name\n- score\n- distance\n\nSee [Order By](doc:order-by) guide in left sidebar for information on how to use the `order_by` argument.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Pagination\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Note\",\n  \"body\": \"This endpoint returns results paginated. If `limit` is set to 24 (the default), you will at most get 24 items.\"\n}\n[/block]","excerpt":"","slug":"catalog-list","type":"endpoint","title":"Catalog List"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

_token:
required
string
The API session token.
_signature:
string
The session signature, verifying your session. This is not required from a website.
limit:
integer24
Results per response.
offset:
integer0
Resultset offset. Used for pagination.
r_lat:
double
Request latitude.
r_lng:
double
Request longitude.
r_radius:
double
Limit content to this radius (in meters).
order_by:
string-popularity,-created
Resultset order.
dealer_ids:
string
Comma-seperated list of dealer ids. The result will be limted to catalogs matching this filter.
store_ids:
string
Comma-seperated list of store ids. The result will be limted to catalogs matching this filter.
catalog_ids:
string
Comma-seperated list of catalog ids. The result will be limted to catalogs matching this filter.

Result Format


Documentation

This endpoint retrieves a list of publicly accessible catalogs. When you need a list of catalogs, this is most likely the endpoint you will need. [block:api-header] { "type": "basic", "title": "Order By" } [/block] The available orderings are; - popularity - created - expiration_date - publication_date - valid_date - dealer - name - score - distance See [Order By](doc:order-by) guide in left sidebar for information on how to use the `order_by` argument. [block:api-header] { "type": "basic", "title": "Pagination" } [/block] [block:callout] { "type": "warning", "title": "Note", "body": "This endpoint returns results paginated. If `limit` is set to 24 (the default), you will at most get 24 items." } [/block]