Return list of rma data objects based on search criteria

GET /V1/returns

Query parameters

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

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

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

Condition type
searchCriteria[sortOrders][0][field] string

Sorting field.
searchCriteria[sortOrders][0][direction] string

Sorting direction.
searchCriteria[pageSize] integer

Page size.
searchCriteria[currentPage] integer

Current page.

Responses

200

200 Success.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Interface RmaInterface
  
  Hide items attributes Show items attributes object
  
  increment_id string Required
  
  Entity_id
  
  entity_id integer Required
  
  Entity_id
  
  order_id integer Required
  
  Order_id
  
  order_increment_id string Required
  
  Order_increment_id
  
  store_id integer Required
  
  Store_id
  
  customer_id integer
  
  Customer_id
  
  date_requested string Required
  
  Date_requested
  
  customer_custom_email string Required
  
  Customer_custom_email
  
  items array[object] Required
  
  Interface CategoryInterface
  
  Hide items attributes Show items attributes object
  
  entity_id integer Required
  
  Id
  
  rma_entity_id integer Required
  
  RMA id
  
  order_item_id integer Required
  
  Order_item_id
  
  qty_requested integer Required
  
  Qty_requested
  
  qty_authorized integer Required
  
  Qty_authorized
  
  qty_approved integer Required
  
  Qty_approved
  
  qty_returned integer Required
  
  Qty_returned
  
  reason string Required
  
  Reason
  
  condition string Required
  
  Condition
  
  resolution string Required
  
  Resolution
  
  status string Required
  
  Status
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Rma\Api\Data\ItemInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  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 Required
  
  Status
  
  comments array[object] Required
  
  Interface CommentInterface
  
  Hide comments attributes Show comments attributes object
  
  comment string Required
  
  Comment
  
  rma_entity_id integer Required
  
  Rma Id
  
  created_at string Required
  
  Created_at
  
  entity_id integer Required
  
  Entity_id
  
  customer_notified boolean Required
  
  Is_customer_notified
  
  visible_on_front boolean Required
  
  Is_visible_on_front
  
  status string Required
  
  Status
  
  admin boolean Required
  
  Is_admin
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Rma\Api\Data\CommentInterface
  
  custom_attributes array[object]
  
  Interface for custom attribute value.
  
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  attribute_code string Required
  
  Attribute code
  
  value string Required
  
  Attribute value
  
  tracks array[object] Required
  
  Interface TrackInterface
  
  Hide tracks attributes Show tracks attributes object
  
  entity_id integer Required
  
  Entity id
  
  rma_entity_id integer Required
  
  Rma entity id
  
  track_number string Required
  
  Track number
  
  carrier_title string Required
  
  Carrier title
  
  carrier_code string Required
  
  Carrier code
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Rma\Api\Data\TrackInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  status string
  
  delivery_time string
  
  external_updated_at string
  
  label_filename string
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Rma\Api\Data\RmaInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  rma_return_address object
  
  Hide rma_return_address attributes Show rma_return_address attributes object
  
  rma_id integer
  
  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 array[object]
  
  Interface for custom attribute value.
  
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  attribute_code string Required
  
  Attribute code
  
  value string Required
  
  Attribute value
- search_criteria object Required
  
  Search criteria interface.
  
  Hide search_criteria attributes Show search_criteria attributes object
  
  filter_groups array[object] Required
  
  Groups two or more filters together using a logical OR
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  filters array[object]
  
  Filter which can be used by any methods from service layer.
  
  Hide filters attributes Show filters attributes object
  
  field string Required
  
  Field
  
  value string Required
  
  Value
  
  condition_type string
  
  Condition type
  
  sort_orders array[object]
  
  Data object for sort order.
  
  Hide sort_orders attributes Show sort_orders attributes object
  
  field string Required
  
  Sorting field.
  
  direction string Required
  
  Sorting direction.
  
  page_size integer
  
  Page size.
  
  current_page integer
  
  Current page.
- total_count integer Required
  
  Total count.
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/returns

curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/returns

Response examples (200)

{
  "items": [
    {
      "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"
        }
      ]
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 42,
    "current_page": 42
  },
  "total_count": 42
}

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 (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}