List of all articles

Request

Using this endpoint, you can get list of all articles with detailed info of each article (like in Detail of article endpoint) asynchronously.

See how Asynchronous requests work on our developer's portal.

Response will be in jsonlines format with each article taking one line of output file.

One article in response has the same format as article detail response. See Article snapshot schema for more details.

Result file is compressed using GZIP.

Security

shoptetAccessToken or shoptetPrivateApiToken

Query

idFrominteger

Export articles with id bigger or equal than given value

Example:idFrom=1

idTointeger

Export articles with id lower or equal than given value

Example:idTo=10

articleLanguagestring

Export articles written in given language

Example:articleLanguage=cs

publishDateFromstring

Export articles published after given datetime

Example:publishDateFrom=2014-09-05T00:00:00%2B0000

publishDateTostring

Export articles published before given datetime

Example:publishDateTo=2014-11-05T00:00:00%2B0000

changeDateFromstring

Export articles updated after given datetime

Example:changeDateFrom=2014-09-05T00:00:00%2B0000

changeDateTostring

Export articles updated before given datetime

Example:changeDateTo=2014-11-05T00:00:00%2B0000

visibleboolean

Filtering according to document visibility

Example:visible=true

Headers

Content-Typestringrequired

Default:"application/json"

curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/articles/snapshot?idFrom=1&idTo=10&articleLanguage=cs&publishDateFrom=2014-09-05T00%3A00%3A00%252B0000&publishDateTo=2014-11-05T00%3A00%3A00%252B0000&changeDateFrom=2014-09-05T00%3A00%3A00%252B0000&changeDateTo=2014-11-05T00%3A00%3A00%252B0000&visible=true' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

Accepted

Bodyapplication/json

dataobject

errorsArray of objects or null(Errors)

metadataobject(Metadata)

Response

{
  "data": {
    "jobId": "ad24xod"
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}