ReDoc documentation

returns/{id}

returns/{id}

get/V1/returns/{id}

Return data object for specified RMA id

Request
path Parameters
id
required
integer
Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "increment_id": "string",
  • "entity_id": 0,
  • "order_id": 0,
  • "order_increment_id": "string",
  • "store_id": 0,
  • "customer_id": 0,
  • "date_requested": "string",
  • "customer_custom_email": "string",
  • "items": [
    ],
  • "status": "string",
  • "comments": [
    ],
  • "tracks": [
    ],
  • "extension_attributes": { },
  • "custom_attributes": [
    ]
}

returns/{id}

delete/V1/returns/{id}

Delete RMA

Request
path Parameters
id
required
string
Request Body schema:
required
object (rma-data-rma-interface)

Interface RmaInterface

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "rmaDataObject": {
    }
}
Response samples
true

returns/{id}

put/V1/returns/{id}

Save RMA

Request
path Parameters
id
required
string
Request Body schema:
required
object (rma-data-rma-interface)

Interface RmaInterface

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "rmaDataObject": {
    }
}
Response samples
{
  • "increment_id": "string",
  • "entity_id": 0,
  • "order_id": 0,
  • "order_increment_id": "string",
  • "store_id": 0,
  • "customer_id": 0,
  • "date_requested": "string",
  • "customer_custom_email": "string",
  • "items": [
    ],
  • "status": "string",
  • "comments": [
    ],
  • "tracks": [
    ],
  • "extension_attributes": { },
  • "custom_attributes": [
    ]
}
➔ Next to returns/{id}/comments