ReDoc documentation

creditmemo/{id}/comments

creditmemo/{id}/comments

get/V1/creditmemo/{id}/comments

Lists comments for a specified credit memo.

Request
path Parameters
id
required
integer

The credit memo ID.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}

creditmemo/{id}/comments

post/V1/creditmemo/{id}/comments

Performs persist operations for a specified entity.

Request
path Parameters
id
required
string
Request Body schema:
required
object (sales-data-creditmemo-comment-interface)

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.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "entity": {
    }
}
Response samples
{
  • "comment": "string",
  • "created_at": "string",
  • "entity_id": 0,
  • "is_customer_notified": 0,
  • "is_visible_on_front": 0,
  • "parent_id": 0,
  • "extension_attributes": { }
}
➔ Next to creditmemo/{id}/emails