ReDoc documentation

returns

returns

post/V1/returns

Save RMA

Request
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": [
    ]
}

returns

get/V1/returns

Return list of rma data objects based on search criteria

Request
query Parameters
searchCriteria[currentPage]
integer

Current page.

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[pageSize]
integer

Page size.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[sortOrders][0][field]
string

Sorting field.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}
➔ Next to returns/{id}