Performs persist operations for a specified entity

POST /V1/creditmemo/{id}/comments

Performs persist operations for a specified entity.

Path parameters

id string Required

Body

entity object Required

Credit memo comment interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo usually includes comments that detail why the credit memo amount was credited to the customer.
Hide entity attributes Show entity attributes object
- comment string Required
  
  Comment.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Credit memo ID.
- is_customer_notified integer Required
  
  Is-customer-notified flag value.
- is_visible_on_front integer Required
  
  Is-visible-on-storefront flag value.
- parent_id integer Required
  
  Parent ID.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface

Body

entity object Required

Credit memo comment interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo usually includes comments that detail why the credit memo amount was credited to the customer.
Hide entity attributes Show entity attributes object
- comment string Required
  
  Comment.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Credit memo ID.
- is_customer_notified integer Required
  
  Is-customer-notified flag value.
- is_visible_on_front integer Required
  
  Is-visible-on-storefront flag value.
- parent_id integer Required
  
  Parent ID.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface

Responses

200

application/json

application/json application/xml

200 Success.
Hide response attributes Show response attributes object
- comment string Required
  
  Comment.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Credit memo ID.
- is_customer_notified integer Required
  
  Is-customer-notified flag value.
- is_visible_on_front integer Required
  
  Is-visible-on-storefront flag value.
- parent_id integer Required
  
  Parent ID.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface
Hide response attributes Show response attributes object
- comment string Required
  
  Comment.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Credit memo ID.
- is_customer_notified integer Required
  
  Is-customer-notified flag value.
- is_visible_on_front integer Required
  
  Is-visible-on-storefront flag value.
- parent_id integer Required
  
  Parent ID.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface
401

application/json

application/json application/xml

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

application/json

application/json application/xml

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

application/json

application/json application/xml

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

POST /V1/creditmemo/{id}/comments

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/creditmemo/{id}/comments' \
 --header "Content-Type: application/json" \
 --data '{"entity":{"comment":"string","created_at":"string","entity_id":42,"is_customer_notified":42,"is_visible_on_front":42,"parent_id":42,"extension_attributes":{}}}'

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/creditmemo/{id}/comments' \
 --header "Content-Type: application/xml"

Request examples

{
  "entity": {
    "comment": "string",
    "created_at": "string",
    "entity_id": 42,
    "is_customer_notified": 42,
    "is_visible_on_front": 42,
    "parent_id": 42,
    "extension_attributes": {}
  }
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <entity>
    <comment>string</comment>
    <created-at>string</created-at>
    <entity-id type="integer">42</entity-id>
    <is-customer-notified type="integer">42</is-customer-notified>
    <is-visible-on-front type="integer">42</is-visible-on-front>
    <parent-id type="integer">42</parent-id>
    <extension-attributes>
    </extension-attributes>
  </entity>
</root>

Response examples (200)

{
  "comment": "string",
  "created_at": "string",
  "entity_id": 42,
  "is_customer_notified": 42,
  "is_visible_on_front": 42,
  "parent_id": 42,
  "extension_attributes": {}
}

Response examples (200)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <comment>string</comment>
  <created-at>string</created-at>
  <entity-id type="integer">42</entity-id>
  <is-customer-notified type="integer">42</is-customer-notified>
  <is-visible-on-front type="integer">42</is-visible-on-front>
  <parent-id type="integer">42</parent-id>
  <extension-attributes>
  </extension-attributes>
</root>

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (401)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

Response examples (400)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (400)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>