Skip to content

Register credit memo

POST
/V1/return/creditmemo

Register the credit memo issued for a return and complete it. Requires creditmemo_number; validates items[] and shipping_amount_incl_tax against the return. doc_binary, when sent, must be a base64-encoded PDF. Idempotent: re-sending the same credit memo number returns the completed return without re-processing.

object
creditmemo
required

Credit memo registered for a return. The items and the shipping amount are checked against the return; the credit memo itself always mirrors the return as stored.

object
return_id
required

The return number (e.g. R000000123); the return entity ID is accepted as well.

string
items
required

Every item of the return with its returned qty, no more and no less.

Array<object>

Return item confirmed by the credit memo. Used for validation only: the credit memo is always registered for the items and quantities stored on the return.

object
item_id
required

The return item ID (items[].id of the return).

integer
qty

The qty; must equal the qty of the return item.

number
shipping_amount_incl_tax

The returned shipping of the original order incl. tax: return_shipping_amount of the return.

number
creditmemo_number
required

The credit memo number; unique across returns.

string
creditmemo_time

The credit memo time, format yyyy-mm-ddThh:mm:ss+hh:mm.

string
additional_data

Additional credit memo data as a JSON encoded string.

string
doc_binary

The credit memo document, base64 encoded PDF.

string
Example generated
{
"creditmemo": {
"return_id": "example",
"items": [
{
"item_id": 1,
"qty": 1
}
],
"shipping_amount_incl_tax": 1,
"creditmemo_number": "example",
"creditmemo_time": "example",
"additional_data": "example",
"doc_binary": "example"
}
}

200 Success.

object
id
required
integer
return_number
required
string
fulfillment_order_id
required
integer
fulfillment_order_number
string
order_number

Order number (increment id).

string
sales_order_number

The sales channel order number.

string
channel_code
string
warehouse_code
string
customer_firstname
string
customer_lastname
string
customer_email
string
customer_name

Name as entered on the return document.

string
status
required
string
settlement_type
required

The settlement direction from the sign of settlement_total: refund (> 0), charge (< 0) or none (0).

string
return_reason
string
total_qty
required
number
return_shipping_amount
required

The original order shipping refunded with the return; 0 when the return does not include it.

number
return_grand_total
required

The total of the returned side: returned items plus return_shipping_amount, incl. tax.

number
replacement_order_id
integer
replacement_order_number
string
replacement_shipping_amount
required

The shipping charged on the replacement, incl. tax; 0 when none is charged.

number
replacement_grand_total
required

The total of the replacement: replacement items plus replacement_shipping_amount, incl. tax.

number
settlement_total
required

The signed balance: return_grand_total - replacement_grand_total; negative when the customer pays.

number
creditmemo_number

The credit memo number; absent until the credit memo is registered.

string
creditmemo_time

The credit memo time; absent until registered, or when the credit memo was sent without one.

string
completed_at

The time the return was completed; absent while it is not complete.

string
created_at
required
string
updated_at
string
items
required
Array<object>
object
id
required
integer
fulfillment_order_item_id
integer
order_item_id
integer
sku
required
string
erp_sku
string
name
string
qty
required
number
price
required
number
row_total
required
number
description
string
Example generated
{
"id": 1,
"return_number": "example",
"fulfillment_order_id": 1,
"fulfillment_order_number": "example",
"order_number": "example",
"sales_order_number": "example",
"channel_code": "example",
"warehouse_code": "example",
"customer_firstname": "example",
"customer_lastname": "example",
"customer_email": "example",
"customer_name": "example",
"status": "example",
"settlement_type": "example",
"return_reason": "example",
"total_qty": 1,
"return_shipping_amount": 1,
"return_grand_total": 1,
"replacement_order_id": 1,
"replacement_order_number": "example",
"replacement_shipping_amount": 1,
"replacement_grand_total": 1,
"settlement_total": 1,
"creditmemo_number": "example",
"creditmemo_time": "example",
"completed_at": "example",
"created_at": "example",
"updated_at": "example",
"items": [
{
"id": 1,
"fulfillment_order_item_id": 1,
"order_item_id": 1,
"sku": "example",
"erp_sku": "example",
"name": "example",
"qty": 1,
"price": 1,
"row_total": 1,
"description": "example"
}
]
}

400 Bad Request

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
"message": "example",
"errors": [
{
"message": "example",
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
]
}
],
"code": 1,
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
],
"trace": "example"
}

401 Unauthorized

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
"message": "example",
"errors": [
{
"message": "example",
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
]
}
],
"code": 1,
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
],
"trace": "example"
}

Internal Server error

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
"message": "example",
"errors": [
{
"message": "example",
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
]
}
],
"code": 1,
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
],
"trace": "example"
}

Unexpected error

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
"message": "example",
"errors": [
{
"message": "example",
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
]
}
],
"code": 1,
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
],
"trace": "example"
}