creditmemo - Magento B2B API

Performs persist operations for a specified credit memo.

curl --location -g --request POST 'http:///V1/creditmemo' \ --header 'Content-Type: application/json' \ --data-raw '{ "entity": { "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" } }'

{ "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" }

请求参数

Body 参数application/json

entity

object (sales-data-creditmemo-interface)

必需

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.

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.

示例

返回响应

🟢200成功

application/json

200 Success.

Body

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.

comment

string

Comment.

必需

created_at

string

可选

Created-at timestamp.

entity_id

integer

可选

Credit memo ID.

extension_attributes

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

可选

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

is_customer_notified

integer

必需

Is-customer-notified flag value.

is_visible_on_front

integer

必需

Is-visible-on-storefront flag value.

parent_id

integer

必需

Parent 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.

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

base_customer_balance_amount

number

可选

base_gift_cards_amount

number

可选

customer_balance_amount

number

可选

gift_cards_amount

number

可选

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

可选

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.

additional_data

string

可选

Additional data.

base_cost

number

必需

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

必需

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.

discount_tax_compensation_amount

number

可选

Discount tax compensation amount.

entity_id

integer

必需

Credit memo item ID.

extension_attributes

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

可选

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

name

string

Name.

可选

order_item_id

integer

必需

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

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.

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.

🟠401没有权限

🔴500服务器错误