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

Responses

  • 200

    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

  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • 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 item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • 400

    400 Bad Request

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • 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 item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • 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 item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • 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' \
 --data '{"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
{
  "entity": {
    "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)
{
  "comment": "string",
  "created_at": "string",
  "entity_id": 42,
  "is_customer_notified": 42,
  "is_visible_on_front": 42,
  "parent_id": 42,
  "extension_attributes": {}
}
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 (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 (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}