Skip to content

List of discussion posts

Request

List of discussion posts, filterable by product GUID, article ID, page ID, customer GUID, author's e-mail, and creation date. Requires "discussion" module to be active.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
productGuidstring

guid of the product associated to discussion

Example:productGuid=356eb81e-d966-11e0-b04f-57a43310b768
articleIdinteger

identifier of the article associated to discussion

Example:articleId=1
pageIdinteger

identifier of the page associated to discussion

Example:pageId=1
customerGuidstring

guid of the customer associated to discussion

Example:customerGuid=443cad54-73bc-11e8-8216-002590dad85e
userEmailstring

e-mail of the post's author

Example:userEmail=john.doe@example.com
creationDateFromstring

date and time of the post creation - lower limit

Example:creationDateFrom=2022-12-24T16:00:00+02:00
creationDateTostring

date and time of the post creation - upper limit

Example:creationDateTo=2022-12-31T23:59:59+02:00
itemsPerPageinteger

Returned items per page. Default and max value is 100.

Example:itemsPerPage=98
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/discussions-posts?productGuid=356eb81e-d966-11e0-b04f-57a43310b768&articleId=1&pageId=1&customerGuid=443cad54-73bc-11e8-8216-002590dad85e&userEmail=john.doe%40example.com&creationDateFrom=2022-12-24T16%3A00%3A00%2B02%3A00&creationDateTo=2022-12-31T23%3A59%3A59%2B02%3A00&itemsPerPage=98&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "discussion": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}