creditmemos

GET

/V1/creditmemos

creditmemos

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.

响应示例

200 - 示例 1

{
    "items": [
        {
            "adjustment": 0,
            "adjustment_negative": 0,
            "adjustment_positive": 0,
            "base_adjustment": 0,
            "base_adjustment_negative": 0,
            "base_adjustment_positive": 0,
            "base_currency_code": "string",
            "base_discount_amount": 0,
            "base_discount_tax_compensation_amount": 0,
            "base_grand_total": 0,
            "base_shipping_amount": 0,
            "base_shipping_discount_tax_compensation_amnt": 0,
            "base_shipping_incl_tax": 0,
            "base_shipping_tax_amount": 0,
            "base_subtotal": 0,
            "base_subtotal_incl_tax": 0,
            "base_tax_amount": 0,
            "base_to_global_rate": 0,
            "base_to_order_rate": 0,
            "billing_address_id": 0,
            "comments": [
                {
                    "comment": "string",
                    "created_at": "string",
                    "entity_id": 0,
                    "extension_attributes": {},
                    "is_customer_notified": 0,
                    "is_visible_on_front": 0,
                    "parent_id": 0
                }
            ],
            "created_at": "string",
            "creditmemo_status": 0,
            "discount_amount": 0,
            "discount_description": "string",
            "discount_tax_compensation_amount": 0,
            "email_sent": 0,
            "entity_id": 0,
            "extension_attributes": {
                "base_customer_balance_amount": 0,
                "base_gift_cards_amount": 0,
                "customer_balance_amount": 0,
                "gift_cards_amount": 0,
                "gw_base_price": "string",
                "gw_base_tax_amount": "string",
                "gw_card_base_price": "string",
                "gw_card_base_tax_amount": "string",
                "gw_card_price": "string",
                "gw_card_tax_amount": "string",
                "gw_items_base_price": "string",
                "gw_items_base_tax_amount": "string",
                "gw_items_price": "string",
                "gw_items_tax_amount": "string",
                "gw_price": "string",
                "gw_tax_amount": "string"
            },
            "global_currency_code": "string",
            "grand_total": 0,
            "increment_id": "string",
            "invoice_id": 0,
            "items": [
                {
                    "additional_data": "string",
                    "base_cost": 0,
                    "base_discount_amount": 0,
                    "base_discount_tax_compensation_amount": 0,
                    "base_price": 0,
                    "base_price_incl_tax": 0,
                    "base_row_total": 0,
                    "base_row_total_incl_tax": 0,
                    "base_tax_amount": 0,
                    "base_weee_tax_applied_amount": 0,
                    "base_weee_tax_applied_row_amnt": 0,
                    "base_weee_tax_disposition": 0,
                    "base_weee_tax_row_disposition": 0,
                    "description": "string",
                    "discount_amount": 0,
                    "discount_tax_compensation_amount": 0,
                    "entity_id": 0,
                    "extension_attributes": {
                        "invoice_text_codes": [
                            "string"
                        ],
                        "tax_codes": [
                            "string"
                        ],
                        "vertex_tax_codes": [
                            "string"
                        ]
                    },
                    "name": "string",
                    "order_item_id": 0,
                    "parent_id": 0,
                    "price": 0,
                    "price_incl_tax": 0,
                    "product_id": 0,
                    "qty": 0,
                    "row_total": 0,
                    "row_total_incl_tax": 0,
                    "sku": "string",
                    "tax_amount": 0,
                    "weee_tax_applied": "string",
                    "weee_tax_applied_amount": 0,
                    "weee_tax_applied_row_amount": 0,
                    "weee_tax_disposition": 0,
                    "weee_tax_row_disposition": 0
                }
            ],
            "order_currency_code": "string",
            "order_id": 0,
            "shipping_address_id": 0,
            "shipping_amount": 0,
            "shipping_discount_tax_compensation_amount": 0,
            "shipping_incl_tax": 0,
            "shipping_tax_amount": 0,
            "state": 0,
            "store_currency_code": "string",
            "store_id": 0,
            "store_to_base_rate": 0,
            "store_to_order_rate": 0,
            "subtotal": 0,
            "subtotal_incl_tax": 0,
            "tax_amount": 0,
            "transaction_id": "string",
            "updated_at": "string"
        }
    ],
    "search_criteria": {
        "current_page": 0,
        "filter_groups": [
            {
                "filters": [
                    {
                        "condition_type": "string",
                        "field": "string",
                        "value": "string"
                    }
                ]
            }
        ],
        "page_size": 0,
        "sort_orders": [
            {
                "direction": "string",
                "field": "string"
            }
        ]
    },
    "total_count": 0
}

请求参数

Query 参数

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.

返回响应

🟢200成功

application/json

200 Success.

Body

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

items

array[object (sales-data-creditmemo-interface) {51}]

必需

Array of collection items.

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_discount_tax_compensation_amount

number

可选

Credit memo base discount tax compensation amount.

base_grand_total

number

可选

Credit memo base grand total.

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.

comments

array[object (sales-data-creditmemo-comment-interface) {7}]

可选

Array of any credit memo comments. Otherwise, null.

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.

discount_tax_compensation_amount

number

可选

Credit memo discount tax compensation amount.

email_sent

integer

可选

Credit memo email sent flag value.

entity_id

integer

可选

Credit memo ID.

extension_attributes

object (sales-data-creditmemo-extension-interface)

可选

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

global_currency_code

string

可选

Credit memo global currency code.

grand_total

number

可选

Credit memo grand total.

increment_id

string

可选

Credit memo increment ID.

invoice_id

integer

可选

Credit memo invoice ID.

items

array[object (sales-data-creditmemo-item-interface) {34}]

必需

Array of credit memo items.

order_currency_code

string

可选

Credit memo order currency code.

order_id

integer

必需

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.

search_criteria

object (framework-search-criteria-interface)

必需

Search criteria interface.

current_page

integer

可选

Current page.

filter_groups

array[object (framework-search-filter-group) {1}]

必需

A list of filter groups.

page_size

integer

可选

Page size.

sort_orders

array[object (framework-sort-order) {2}]

可选

Sort order.

total_count

integer

必需

Total count.

🟠401没有权限

🔴500服务器错误

修改于 2024-11-22 03:29:06

creditmemo/{id}/emails

customerGroups