ReDoc documentation

creditmemo/refund

creditmemo/refund

post/V1/creditmemo/refund

Prepare creditmemo to refund and save it.

Request
Request Body schema:
required
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.

offlineRequested
boolean
Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "creditmemo": {
    },
  • "offlineRequested": true
}
Response samples
{
  • "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_grand_total": 0,
  • "base_discount_tax_compensation_amount": 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,
  • "created_at": "string",
  • "creditmemo_status": 0,
  • "discount_amount": 0,
  • "discount_description": "string",
  • "email_sent": 0,
  • "entity_id": 0,
  • "global_currency_code": "string",
  • "grand_total": 0,
  • "discount_tax_compensation_amount": 0,
  • "increment_id": "string",
  • "invoice_id": 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",
  • "items": [
    ],
  • "comments": [
    ],
  • "extension_attributes": {
    }
}
➔ Next to creditmemo/{id}