Skip to main content

Get Comments

GET /comments​

Parameters​

  • saleId (string, query, optional): The ID of the sale.
  • tenantId (string, query, optional): The ID of the tenant.
  • deliveryStatus (string, query, optional): The delivery status of the comment. Available values: PENDING, REJECTED, CANCELLED, ACCEPTED, SHIPPED, DELIVERED, CONFIRMED, RETURNED, RETURN_CONFIRMED, READY_TO_SHIP, READY_FOR_PICKUP, PICKING, PACKED.
  • commentedBy (string, query, optional): The user who made the comment.
  • commentStatus (string, query, optional): The status of the comment. Available values: OPEN, CLOSED.
  • from (string, query, optional): The start date for the comments.
  • to (string, query, optional): The end date for the comments.
  • locale.baseLocale.language (string, query, optional): The language of the locale.
  • locale.baseLocale.script (string, query, optional): The script of the locale.
  • locale.baseLocale.region (string, query, optional): The region of the locale.
  • locale.baseLocale.variant (string, query, optional): The variant of the locale.

Responses​

200 OK​

  • Media Type: application/json

Example Value​

{
  "message": "string",
  "data": [
    {
      "id": 0,
      "uuid": "string",
      "createdAt": "2024-07-18T16:41:01.138Z",
      "updatedAt": "2024-07-18T16:41:01.138Z",
      "saleId": "string",
      "tenantId": "string",
      "status": "string",
      "comments": "string",
      "commentedBy": "string",
      "commentStatus": "string",
      "countryCode": "string"
    }
  ],
  "meta": {
    "currentPage": 0,
    "from": 0,
    "to": 0,
    "perPage": 0,
    "total": 0,
    "lastPage": 0
  }
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /comments \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!