Comments

sales Creditmemo Management V1Get Comments List Get

Lists comments for a specified credit memo.

get

/V1/creditmemo/{id}/comments

Path parameters

idstringrequired

(Required) The credit memo ID.

Example: <integer>

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{baseurl}}/V1/creditmemo/{id}/comments'

200

401

500

200

{
  "items": [
    {
      "comment": "<string>",
      "is_customer_notified": "<integer>",
      "is_visible_on_front": "<integer>",
      "parent_id": "<integer>",
      "created_at": "<string>",
      "entity_id": "<integer>",
      "extension_attributes": "<object>"
    },
    {
      "comment": "<string>",
      "is_customer_notified": "<integer>",
      "is_visible_on_front": "<integer>",
      "parent_id": "<integer>",
      "created_at": "<string>",
      "entity_id": "<integer>",
      "extension_attributes": "<object>"
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "cupidatat",
            "value": "do incididunt",
            "condition_type": "esse reprehenderit aliquip incididunt"
          },
          {
            "field": "veniam nulla eiusmod",
            "value": "cupidatat cillum consequat aliqua",
            "condition_type": "ut enim amet reprehenderit"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "laboru",
            "value": "nulla aliquip elit in sint",
            "condition_type": "in"
          },
          {
            "field": "commodo Excepteur",
            "value": "elit proident in",
            "condition_type": "ad adipisicing dolor minim"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "in ad eu ir",
        "direction": "commodo est consectetur"
      },
      {
        "field": "pariatur sed",
        "direction": "cillum"
      }
    ],
    "page_size": 69152303,
    "current_page": -57111665
  },
  "total_count": 41586941
}

OK

sales Creditmemo Comment Repository V1Save Post

Performs persist operations for a specified entity.

post

/V1/creditmemo/{id}/comments

Path parameters

idstringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"entity":{"comment":"<string>","is_customer_notified":"<integer>","is_visible_on_front":"<integer>","parent_id":"<integer>","created_at":"<string>","entity_id":"<integer>","extension_attributes":"<object>"}}

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/creditmemo/{id}/comments' \
  --header 'Content-Type: application/json' \
  --data '{
    "entity": {
      "comment": "<string>",
      "is_customer_notified": "<integer>",
      "is_visible_on_front": "<integer>",
      "parent_id": "<integer>",
      "created_at": "<string>",
      "entity_id": "<integer>",
      "extension_attributes": "<object>"
    }
  }'

200

400

401

500

200

{
  "comment": "<string>",
  "is_customer_notified": "<integer>",
  "is_visible_on_front": "<integer>",
  "parent_id": "<integer>",
  "created_at": "<string>",
  "entity_id": "<integer>",
  "extension_attributes": "<object>"
}

OK