Body
-
Interface RmaInterface
DELETE /V1/returns/{id}
curl \
-X DELETE https://magento2.winkelstraat.mac/rest/all/V1/returns/{id} \
-d '{"rmaDataObject":{"increment_id":"string","entity_id":42,"order_id":42,"order_increment_id":"string","store_id":42,"customer_id":42,"date_requested":"string","customer_custom_email":"string","items":[{"entity_id":42,"rma_entity_id":42,"order_item_id":42,"qty_requested":42,"qty_authorized":42,"qty_approved":42,"qty_returned":42,"reason":"string","condition":"string","resolution":"string","status":"string","extension_attributes":{"merchant_resolution_code":"string","reason_code":"string","resolution_code":"string","product_color":"string","product_size":"string","product_merchant_code":"string","product_merchant_name":"string","product_merchant_product_reference":"string","product_manufacturer_code":"string","product_manufacturer_name":"string","exchange_size":"string"}}],"status":"string","comments":[{"comment":"string","rma_entity_id":42,"created_at":"string","entity_id":42,"customer_notified":true,"visible_on_front":true,"status":"string","admin":true,"extension_attributes":{},"custom_attributes":[{"attribute_code":"string","value":"string"}]}],"tracks":[{"entity_id":42,"rma_entity_id":42,"track_number":"string","carrier_title":"string","carrier_code":"string","extension_attributes":{"status":"string","delivery_time":"string","external_updated_at":"string","label_filename":"string"}}],"extension_attributes":{"rma_return_address":{"rma_id":42,"name":"string","street":"string","city":"string","country_id":"string","postcode":"string","telephone":"string","email":"string"},"merchant_code":"string","date_received":"string","customer_firstname":"string","customer_lastname":"string","date_processed":"string","shipping_address_customer_firstname":"string","shipping_address_customer_lastname":"string"},"custom_attributes":[{"attribute_code":"string","value":"string"}]}}'
Request examples
{
"rmaDataObject": {
"increment_id": "string",
"entity_id": 42,
"order_id": 42,
"order_increment_id": "string",
"store_id": 42,
"customer_id": 42,
"date_requested": "string",
"customer_custom_email": "string",
"items": [
{
"entity_id": 42,
"rma_entity_id": 42,
"order_item_id": 42,
"qty_requested": 42,
"qty_authorized": 42,
"qty_approved": 42,
"qty_returned": 42,
"reason": "string",
"condition": "string",
"resolution": "string",
"status": "string",
"extension_attributes": {
"merchant_resolution_code": "string",
"reason_code": "string",
"resolution_code": "string",
"product_color": "string",
"product_size": "string",
"product_merchant_code": "string",
"product_merchant_name": "string",
"product_merchant_product_reference": "string",
"product_manufacturer_code": "string",
"product_manufacturer_name": "string",
"exchange_size": "string"
}
}
],
"status": "string",
"comments": [
{
"comment": "string",
"rma_entity_id": 42,
"created_at": "string",
"entity_id": 42,
"customer_notified": true,
"visible_on_front": true,
"status": "string",
"admin": true,
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
],
"tracks": [
{
"entity_id": 42,
"rma_entity_id": 42,
"track_number": "string",
"carrier_title": "string",
"carrier_code": "string",
"extension_attributes": {
"status": "string",
"delivery_time": "string",
"external_updated_at": "string",
"label_filename": "string"
}
}
],
"extension_attributes": {
"rma_return_address": {
"rma_id": 42,
"name": "string",
"street": "string",
"city": "string",
"country_id": "string",
"postcode": "string",
"telephone": "string",
"email": "string"
},
"merchant_code": "string",
"date_received": "string",
"customer_firstname": "string",
"customer_lastname": "string",
"date_processed": "string",
"shipping_address_customer_firstname": "string",
"shipping_address_customer_lastname": "string"
},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
}
Response examples (200)
true
Response examples (401)
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Response examples (400)
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Response examples (default)
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}