Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
/V1/creditmemos
Field
<string>Value
<string>Condition type
<string>Sorting field.
<string>Sorting direction.
<string>Page size.
<integer>Current page.
<integer>curl -L \
--url 'http://{{baseurl}}/V1/creditmemos'{
"items": [
{
"order_id": "<integer>",
"items": [
{
"base_cost": "<number>",
"base_price": "<number>",
"entity_id": "<integer>",
"order_item_id": "<integer>",
"qty": "<number>",
"additional_data": "<string>",
"base_discount_amount": "<number>",
"base_discount_tax_compensation_amount": "<number>",
"base_price_incl_tax": "<number>",
"base_row_total": "<number>",
"base_row_total_incl_tax": "<number>",
"base_tax_amount": "<number>",
"base_weee_tax_applied_amount": "<number>",
"base_weee_tax_applied_row_amnt": "<number>",
"base_weee_tax_disposition": "<number>",
"base_weee_tax_row_disposition": "<number>",
"description": "<string>",
"discount_amount": "<number>",
"discount_tax_compensation_amount": "<number>",
"name": "<string>",
"parent_id": "<integer>",
"price": "<number>",
"price_incl_tax": "<number>",
"product_id": "<integer>",
"row_total": "<number>",
"row_total_incl_tax": "<number>",
"sku": "<string>",
"tax_amount": "<number>",
"weee_tax_applied": "<string>",
"weee_tax_applied_amount": "<number>",
"weee_tax_applied_row_amount": "<number>",
"weee_tax_disposition": "<number>",
"weee_tax_row_disposition": "<number>",
"extension_attributes": {
"vertex_tax_codes": [
"<string>",
"<string>"
],
"invoice_text_codes": [
"<string>",
"<string>"
],
"tax_codes": [
"<string>",
"<string>"
]
}
},
{
"base_cost": "<number>",
"base_price": "<number>",
"entity_id": "<integer>",
"order_item_id": "<integer>",
"qty": "<number>",
"additional_data": "<string>",
"base_discount_amount": "<number>",
"base_discount_tax_compensation_amount": "<number>",
"base_price_incl_tax": "<number>",
"base_row_total": "<number>",
"base_row_total_incl_tax": "<number>",
"base_tax_amount": "<number>",
"base_weee_tax_applied_amount": "<number>",
"base_weee_tax_applied_row_amnt": "<number>",
"base_weee_tax_disposition": "<number>",
"base_weee_tax_row_disposition": "<number>",
"description": "<string>",
"discount_amount": "<number>",
"discount_tax_compensation_amount": "<number>",
"name": "<string>",
"parent_id": "<integer>",
"price": "<number>",
"price_incl_tax": "<number>",
"product_id": "<integer>",
"row_total": "<number>",
"row_total_incl_tax": "<number>",
"sku": "<string>",
"tax_amount": "<number>",
"weee_tax_applied": "<string>",
"weee_tax_applied_amount": "<number>",
"weee_tax_applied_row_amount": "<number>",
"weee_tax_disposition": "<number>",
"weee_tax_row_disposition": "<number>",
"extension_attributes": {
"vertex_tax_codes": [
"<string>",
"<string>"
],
"invoice_text_codes": [
"<string>",
"<string>"
],
"tax_codes": [
"<string>",
"<string>"
]
}
}
],
"adjustment": "<number>",
"adjustment_negative": "<number>",
"adjustment_positive": "<number>",
"base_adjustment": "<number>",
"base_adjustment_negative": "<number>",
"base_adjustment_positive": "<number>",
"base_currency_code": "<string>",
"base_discount_amount": "<number>",
"base_grand_total": "<number>",
"base_discount_tax_compensation_amount": "<number>",
"base_shipping_amount": "<number>",
"base_shipping_discount_tax_compensation_amnt": "<number>",
"base_shipping_incl_tax": "<number>",
"base_shipping_tax_amount": "<number>",
"base_subtotal": "<number>",
"base_subtotal_incl_tax": "<number>",
"base_tax_amount": "<number>",
"base_to_global_rate": "<number>",
"base_to_order_rate": "<number>",
"billing_address_id": "<integer>",
"created_at": "<string>",
"creditmemo_status": "<integer>",
"discount_amount": "<number>",
"discount_description": "<string>",
"email_sent": "<integer>",
"entity_id": "<integer>",
"global_currency_code": "<string>",
"grand_total": "<number>",
"discount_tax_compensation_amount": "<number>",
"increment_id": "<string>",
"invoice_id": "<integer>",
"order_currency_code": "<string>",
"shipping_address_id": "<integer>",
"shipping_amount": "<number>",
"shipping_discount_tax_compensation_amount": "<number>",
"shipping_incl_tax": "<number>",
"shipping_tax_amount": "<number>",
"state": "<integer>",
"store_currency_code": "<string>",
"store_id": "<integer>",
"store_to_base_rate": "<number>",
"store_to_order_rate": "<number>",
"subtotal": "<number>",
"subtotal_incl_tax": "<number>",
"tax_amount": "<number>",
"transaction_id": "<string>",
"updated_at": "<string>",
"comments": [
{
"comment": "<string>",
"is_customer_notified": "<integer>",
"is_visible_on_front": "<integer>",
"parent_id": "<integer>",
"created_at": "<string>",
"entity_id": "<integer>",
"extension_attributes": "<object>"
},
{
"comment": "<string>",
"is_customer_notified": "<integer>",
"is_visible_on_front": "<integer>",
"parent_id": "<integer>",
"created_at": "<string>",
"entity_id": "<integer>",
"extension_attributes": "<object>"
}
],
"extension_attributes": {
"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>"
}
},
{
"order_id": "<integer>",
"items": [
{
"base_cost": "<number>",
"base_price": "<number>",
"entity_id": "<integer>",
"order_item_id": "<integer>",
"qty": "<number>",
"additional_data": "<string>",
"base_discount_amount": "<number>",
"base_discount_tax_compensation_amount": "<number>",
"base_price_incl_tax": "<number>",
"base_row_total": "<number>",
"base_row_total_incl_tax": "<number>",
"base_tax_amount": "<number>",
"base_weee_tax_applied_amount": "<number>",
"base_weee_tax_applied_row_amnt": "<number>",
"base_weee_tax_disposition": "<number>",
"base_weee_tax_row_disposition": "<number>",
"description": "<string>",
"discount_amount": "<number>",
"discount_tax_compensation_amount": "<number>",
"name": "<string>",
"parent_id": "<integer>",
"price": "<number>",
"price_incl_tax": "<number>",
"product_id": "<integer>",
"row_total": "<number>",
"row_total_incl_tax": "<number>",
"sku": "<string>",
"tax_amount": "<number>",
"weee_tax_applied": "<string>",
"weee_tax_applied_amount": "<number>",
"weee_tax_applied_row_amount": "<number>",
"weee_tax_disposition": "<number>",
"weee_tax_row_disposition": "<number>",
"extension_attributes": {
"vertex_tax_codes": [
"<string>",
"<string>"
],
"invoice_text_codes": [
"<string>",
"<string>"
],
"tax_codes": [
"<string>",
"<string>"
]
}
},
{
"base_cost": "<number>",
"base_price": "<number>",
"entity_id": "<integer>",
"order_item_id": "<integer>",
"qty": "<number>",
"additional_data": "<string>",
"base_discount_amount": "<number>",
"base_discount_tax_compensation_amount": "<number>",
"base_price_incl_tax": "<number>",
"base_row_total": "<number>",
"base_row_total_incl_tax": "<number>",
"base_tax_amount": "<number>",
"base_weee_tax_applied_amount": "<number>",
"base_weee_tax_applied_row_amnt": "<number>",
"base_weee_tax_disposition": "<number>",
"base_weee_tax_row_disposition": "<number>",
"description": "<string>",
"discount_amount": "<number>",
"discount_tax_compensation_amount": "<number>",
"name": "<string>",
"parent_id": "<integer>",
"price": "<number>",
"price_incl_tax": "<number>",
"product_id": "<integer>",
"row_total": "<number>",
"row_total_incl_tax": "<number>",
"sku": "<string>",
"tax_amount": "<number>",
"weee_tax_applied": "<string>",
"weee_tax_applied_amount": "<number>",
"weee_tax_applied_row_amount": "<number>",
"weee_tax_disposition": "<number>",
"weee_tax_row_disposition": "<number>",
"extension_attributes": {
"vertex_tax_codes": [
"<string>",
"<string>"
],
"invoice_text_codes": [
"<string>",
"<string>"
],
"tax_codes": [
"<string>",
"<string>"
]
}
}
],
"adjustment": "<number>",
"adjustment_negative": "<number>",
"adjustment_positive": "<number>",
"base_adjustment": "<number>",
"base_adjustment_negative": "<number>",
"base_adjustment_positive": "<number>",
"base_currency_code": "<string>",
"base_discount_amount": "<number>",
"base_grand_total": "<number>",
"base_discount_tax_compensation_amount": "<number>",
"base_shipping_amount": "<number>",
"base_shipping_discount_tax_compensation_amnt": "<number>",
"base_shipping_incl_tax": "<number>",
"base_shipping_tax_amount": "<number>",
"base_subtotal": "<number>",
"base_subtotal_incl_tax": "<number>",
"base_tax_amount": "<number>",
"base_to_global_rate": "<number>",
"base_to_order_rate": "<number>",
"billing_address_id": "<integer>",
"created_at": "<string>",
"creditmemo_status": "<integer>",
"discount_amount": "<number>",
"discount_description": "<string>",
"email_sent": "<integer>",
"entity_id": "<integer>",
"global_currency_code": "<string>",
"grand_total": "<number>",
"discount_tax_compensation_amount": "<number>",
"increment_id": "<string>",
"invoice_id": "<integer>",
"order_currency_code": "<string>",
"shipping_address_id": "<integer>",
"shipping_amount": "<number>",
"shipping_discount_tax_compensation_amount": "<number>",
"shipping_incl_tax": "<number>",
"shipping_tax_amount": "<number>",
"state": "<integer>",
"store_currency_code": "<string>",
"store_id": "<integer>",
"store_to_base_rate": "<number>",
"store_to_order_rate": "<number>",
"subtotal": "<number>",
"subtotal_incl_tax": "<number>",
"tax_amount": "<number>",
"transaction_id": "<string>",
"updated_at": "<string>",
"comments": [
{
"comment": "<string>",
"is_customer_notified": "<integer>",
"is_visible_on_front": "<integer>",
"parent_id": "<integer>",
"created_at": "<string>",
"entity_id": "<integer>",
"extension_attributes": "<object>"
},
{
"comment": "<string>",
"is_customer_notified": "<integer>",
"is_visible_on_front": "<integer>",
"parent_id": "<integer>",
"created_at": "<string>",
"entity_id": "<integer>",
"extension_attributes": "<object>"
}
],
"extension_attributes": {
"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>"
}
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "consequat esse",
"value": "deserunt ad qui",
"condition_type": "esse ullamco fugiat"
},
{
"field": "Ut est elit dolor",
"value": "laborum voluptate de",
"condition_type": "nisi elit sed cupidatat"
}
]
},
{
"filters": [
{
"field": "sunt adipisicing magna eu",
"value": "exercitation sunt laboris commodo",
"condition_type": "voluptate minim aute non"
},
{
"field": "ipsum velit",
"value": "ex sed commodo",
"condition_type": "proident"
}
]
}
],
"sort_orders": [
{
"field": "dolore aliquip ut eiusmo",
"direction": "cillum quis dolor veniam"
},
{
"field": "mollit cillum magna irure",
"direction": "Ut veniam Excepteur sed"
}
],
"page_size": 78717350,
"current_page": 57439063
},
"total_count": -60048293
}OK