Path parameters

• id integer Required

  The credit memo ID.

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  Credit memo comment search result 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.

  • items array[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 items attributes Show items attributes object

    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.

    • 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

  • search_criteria object Required

    Search criteria interface.

    Hide search_criteria attributes Show search_criteria attributes object

    • filter_groups array[object] Required

      Groups two or more filters together using a logical OR

      Hide filter_groups attribute Show filter_groups attribute object

      Groups two or more filters together using a logical OR

      • filters array[object]

        Filter which can be used by any methods from service layer.

        Hide filters attributes Show filters attributes object

        Filter which can be used by any methods from service layer.

        • field string Required

          Field

        • value string Required

          Value

        • condition_type string

          Condition type

    • sort_orders array[object]

      Data object for sort order.

      Hide sort_orders attributes Show sort_orders attributes object

      Data object for sort order.

      • field string Required

        Sorting field.

      • direction string Required

        Sorting direction.

    • page_size integer

      Page size.

    • current_page integer

      Current page.

  • total_count integer Required

    Total count.

• 401

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      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 item

    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

  Unexpected error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      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 item

    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