sales Creditmemo Repository V1Save Post
POST {{baseUrl}}/V1/creditmemo
Performs persist operations for a specified credit memo.
Request Body
{"entity"=>{"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>", "extension_attributes"=>"<object>", "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>"}, {"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>", "extension_attributes"=>"<object>", "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>"}], "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_discount_tax_compensation_amount"=>"<number>", "base_grand_total"=>"<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>", "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>"}], "created_at"=>"<string>", "creditmemo_status"=>"<integer>", "discount_amount"=>"<number>", "discount_description"=>"<string>", "discount_tax_compensation_amount"=>"<number>", "email_sent"=>"<integer>", "entity_id"=>"<integer>", "extension_attributes"=>"<object>", "global_currency_code"=>"<string>", "grand_total"=>"<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>"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
""