Query parameters

• searchCriteria[filterGroups][0][filters][0][field] string

  Field

• searchCriteria[filterGroups][0][filters][0][value] string

  Value

• searchCriteria[filterGroups][0][filters][0][conditionType] string

  Condition type

• searchCriteria[sortOrders][0][field] string

  Sorting field.

• searchCriteria[sortOrders][0][direction] string

  Sorting direction.

• searchCriteria[pageSize] integer

  Page size.

• searchCriteria[currentPage] integer

  Current page.

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  • items array[object] Required

    Credit memo 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.

    Hide items attributes Show items attributes object

    • adjustment number

      Credit memo adjustment.

    • adjustment_negative number

      Credit memo negative adjustment.

    • adjustment_positive number

      Credit memo positive adjustment.

    • base_adjustment number

      Credit memo base adjustment.

    • base_adjustment_negative number

      Credit memo negative base adjustment.

    • base_adjustment_positive number

      Credit memo positive base adjustment.

    • base_currency_code string

      Credit memo base currency code.

    • base_discount_amount number

      Credit memo base discount amount.

    • base_grand_total number

      Credit memo base grand total.

    • base_discount_tax_compensation_amount number

      Credit memo base discount tax compensation amount.

    • base_shipping_amount number

      Credit memo base shipping amount.

    • base_shipping_discount_tax_compensation_amnt number

      Credit memo base shipping discount tax compensation amount.

    • base_shipping_incl_tax number

      Credit memo base shipping including tax.

    • base_shipping_tax_amount number

      Credit memo base shipping tax amount.

    • base_subtotal number

      Credit memo base subtotal.

    • base_subtotal_incl_tax number

      Credit memo base subtotal including tax.

    • base_tax_amount number

      Credit memo base tax amount.

    • base_to_global_rate number

      Credit memo base-to-global rate.

    • base_to_order_rate number

      Credit memo base-to-order rate.

    • billing_address_id integer

      Credit memo billing address ID.

    • created_at string

      Credit memo created-at timestamp.

    • creditmemo_status integer

      Credit memo status.

    • discount_amount number

      Credit memo discount amount.

    • discount_description string

      Credit memo discount description.

    • email_sent integer

      Credit memo email sent flag value.

    • entity_id integer

      Credit memo ID.

    • global_currency_code string

      Credit memo global currency code.

    • grand_total number

      Credit memo grand total.

    • discount_tax_compensation_amount number

      Credit memo discount tax compensation amount.

    • increment_id string

      Credit memo increment ID.

    • invoice_id integer

      Credit memo invoice ID.

    • order_currency_code string

      Credit memo order currency code.

    • order_id integer Required

      Credit memo order ID.

    • shipping_address_id integer

      Credit memo shipping address ID.

    • shipping_amount number

      Credit memo shipping amount.

    • shipping_discount_tax_compensation_amount number

      Credit memo shipping discount tax compensation amount.

    • shipping_incl_tax number

      Credit memo shipping including tax.

    • shipping_tax_amount number

      Credit memo shipping tax amount.

    • state integer

      Credit memo state.

    • store_currency_code string

      Credit memo store currency code.

    • store_id integer

      Credit memo store ID.

    • store_to_base_rate number

      Credit memo store-to-base rate.

    • store_to_order_rate number

      Credit memo store-to-order rate.

    • subtotal number

      Credit memo subtotal.

    • subtotal_incl_tax number

      Credit memo subtotal including tax.

    • tax_amount number

      Credit memo tax amount.

    • transaction_id string

      Credit memo transaction ID.

    • updated_at string

      Credit memo updated-at timestamp.

    • items array[object] Required

      Credit memo item 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 item is an invoiced item for which a merchant creates a credit memo.

      Hide items attributes Show items attributes object

      • additional_data string

        Additional data.

      • base_cost number Required

        The base cost for a credit memo item.

      • base_discount_amount number

        The base discount amount for a credit memo item.

      • base_discount_tax_compensation_amount number

        The base discount tax compensation amount for a credit memo item.

      • base_price number Required

        The base price for a credit memo item.

      • base_price_incl_tax number

        Base price including tax.

      • base_row_total number

        Base row total.

      • base_row_total_incl_tax number

        Base row total including tax.

      • base_tax_amount number

        Base tax amount.

      • base_weee_tax_applied_amount number

        Base WEEE tax applied amount.

      • base_weee_tax_applied_row_amnt number

        Base WEEE tax applied row amount.

      • base_weee_tax_disposition number

        Base WEEE tax disposition.

      • base_weee_tax_row_disposition number

        Base WEEE tax row disposition.

      • description string

        Description.

      • discount_amount number

        Discount amount.

      • entity_id integer Required

        Credit memo item ID.

      • discount_tax_compensation_amount number

        Discount tax compensation amount.

      • name string

        Name.

      • order_item_id integer Required

        Order item ID.

      • parent_id integer

        Parent ID.

      • price number

        Price.

      • price_incl_tax number

        Price including tax.

      • product_id integer

        Product ID.

      • qty number Required

        Quantity.

      • row_total number

        Row total.

      • row_total_incl_tax number

        Row total including tax.

      • sku string

        SKU.

      • tax_amount number

        Tax amount.

      • weee_tax_applied string

        WEEE tax applied.

      • weee_tax_applied_amount number

        WEEE tax applied amount.

      • weee_tax_applied_row_amount number

        WEEE tax applied row amount.

      • weee_tax_disposition number

        WEEE tax disposition.

      • weee_tax_row_disposition number

        WEEE tax row disposition.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemInterface

        Hide extension_attributes attributes Show extension_attributes attributes object

        • status string
        • list_price number
        • size string
        • color string
        • merchant_product_reference string
        • category_code string
        • image string
        • mpn string
        • msrp number
        • manufacturer_code string
        • manufacturer_name string
        • merchant_code string
        • merchant_name string
        • merchant_city string
        • merchant_commission_percentage number
        • merchant_deficiency_percentage number
        • merchant_handling_fee number
        • is_sale boolean
        • return_item_fee number
        • base_return_item_fee number
        • is_outlet boolean
    • comments array[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.

      Hide comments attributes Show comments 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

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoInterface

      Hide extension_attributes attributes Show extension_attributes attributes object

      • base_customer_balance_amount number
      • customer_balance_amount number
      • base_gift_cards_amount number
      • gift_cards_amount number
      • gw_base_price string
      • gw_price string
      • gw_items_base_price string
      • gw_items_price string
      • gw_card_base_price string
      • gw_card_price string
      • gw_base_tax_amount string
      • gw_tax_amount string
      • gw_items_base_tax_amount string
      • gw_items_tax_amount string
      • gw_card_base_tax_amount string
      • gw_card_tax_amount string
      • return_fee number
      • base_return_fee number
      • psp_reference string
      • company_id integer
  • 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

      • filters array[object]

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

        Hide filters attributes Show filters attributes object

        • 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

      • 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

    • message string

      Error message

    • parameters array[object]

      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

    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

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      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

    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