{"_id":"54f9a3a660b3b81700a1a5fb","editedParams":true,"category":{"_id":"54f99f588d09b7390007ea45","__v":4,"pages":["54f9a3a660b3b81700a1a5fb","54f9aabdf2b25a2300d9d8d5","54f9aee229f55225007c75b9","54f9b16829f55225007c75bd"],"project":"543d1e263a300f20000d31fb","version":"543d1e5e5276641a00a593cf","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-06T12:36:40.843Z","from_sync":false,"order":10,"slug":"cms-catalog","title":"CMS Catalog"},"parentDoc":null,"project":"543d1e263a300f20000d31fb","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":2,"editedParams2":true,"user":"54f99d458d09b7390007ea42","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-03-06T12:55:02.024Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"[\n  {\n    \"id\":\"2915RSL\",\n    \"ern\":\"ern:catalog:2915RSL\",\n    \"label\":null,\n    \"background\":null,\n    \"run_from\":\"2015-01-30T23:00:00+0000\",\n    \"run_till\":\"2015-02-13T22:59:59+0000\",\n    \"publish\":\"2015-01-30T08:00:00+0000\",\n    \"uploaded\":\"2015-01-14T10:49:00+0000\",\n    \"page_count\":16,\n    \"offer_count\":0,\n    \"dealer_id\":\"48c56\",\n    \"dimensions\":{\n      \"height\":1.1304354494839,\n      \"width\":1\n    },\n    \"images\":{\n      \":::at:::note.1\":\"this object contains a single image, used to present a catalog (usually the frontpage)\",\n      \"thumb\":\"https:\\/\\/etadevelopment.s3.amazonaws.com\\/img\\/catalog\\/thumb\\/2915RSL-1.jpg\",\n      \"view\":\"https:\\/\\/etadevelopment.s3.amazonaws.com\\/img\\/catalog\\/view\\/2915RSL-1.jpg\",\n      \"zoom\":\"https:\\/\\/etadevelopment.s3.amazonaws.com\\/img\\/catalog\\/zoom\\/2915RSL-1.jpg\"\n    },\n    \"category_ids\":[\n      \"home-garden\"\n    ],\n    \"statistics\":{\n      \"catalog_view\":{\n        \"count\":0,\n        \"uniquecount\":0\n      },\n      \"catalog_pageview\":{\n        \"count\":0,\n        \"uniquecount\":0\n      },\n      \"catalog_offer_view\":{\n        \"count\":0,\n        \"uniquecount\":0\n      }\n    },\n    \"pdf_public\":false,\n    \"pdf_url\":null,\n    \"distribution_ids\":[\n      \"32\"\n    ]\n  }\n  /* more like the above object */\n]","name":"","status":200,"language":"json"},{"status":400,"language":"json","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}","name":""}]},"method":"get","auth":"required","params":[{"_id":"54f9a3a660b3b81700a1a600","ref":"","in":"query","required":true,"desc":"Your API session token.","default":"","type":"string","name":"_token"},{"_id":"54f9a69b60b3b81700a1a607","ref":"","in":"query","required":false,"desc":"Resultset offset. Used for pagination.","default":"0","type":"string","name":"offset"},{"_id":"54f9a69b60b3b81700a1a606","ref":"","in":"query","required":false,"desc":"Results per response.","default":"24","type":"string","name":"limit"},{"_id":"54f9a3a660b3b81700a1a5ff","ref":"","in":"query","required":false,"desc":"Comma-separated list of dealer ids. The result will be limited to catalogs matching this filter.","default":"","type":"string","name":"dealer_ids"},{"_id":"54f9a3a660b3b81700a1a5fe","ref":"","in":"query","required":false,"desc":"Comma-separated list of store ids. The result will be limited to catalogs matching this filter.","default":"","type":"string","name":"store_ids"},{"_id":"54f9a3a660b3b81700a1a5fd","ref":"","in":"query","required":false,"desc":"Comma-separated list of catalog ids. The result will be limited to catalogs matching this filter.","default":"","type":"string","name":"catalog_ids"},{"_id":"54f9a3a660b3b81700a1a5fc","ref":"","in":"query","required":false,"desc":"Time in RFC3339. The result will be limited to catalogs available FROM this time.","default":"","type":"datetime","name":"run_from"},{"_id":"54f9a69b60b3b81700a1a605","ref":"","in":"query","required":false,"desc":"Time in RFC3339. The result will be limited to catalogs available UNTIL this time.","default":"","type":"datetime","name":"run_till"},{"_id":"54f9a7f3f2b25a2300d9d8d3","ref":"","in":"query","required":false,"desc":"Comma-separated list of ordering. Available: page_count, created, dealer, expiration_date, publication_date, valid_date","default":"-created","type":"string","name":"order_by"}],"url":"/v2/cms/catalogs"},"isReference":false,"order":0,"body":"This endpoint retrieves a list catalogs.","excerpt":"This endpoint retrieves a list catalogs.","slug":"cms-catalog-list","type":"endpoint","title":"Catalog List"}

getCatalog List

This endpoint retrieves a list catalogs.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

_token:
required
string
Your API session token.
offset:
string0
Resultset offset. Used for pagination.
limit:
string24
Results per response.
dealer_ids:
string
Comma-separated list of dealer ids. The result will be limited to catalogs matching this filter.
store_ids:
string
Comma-separated list of store ids. The result will be limited to catalogs matching this filter.
catalog_ids:
string
Comma-separated list of catalog ids. The result will be limited to catalogs matching this filter.
run_from:
datetime
Time in RFC3339. The result will be limited to catalogs available FROM this time.
run_till:
datetime
Time in RFC3339. The result will be limited to catalogs available UNTIL this time.
order_by:
string-created
Comma-separated list of ordering. Available: page_count, created, dealer, expiration_date, publication_date, valid_date

Result Format


Documentation

This endpoint retrieves a list catalogs.