Get v1 user rma rma increment

GET /V1/user/rma/{rmaIncrementId}

Path parameters

  • rmaIncrementId string Required

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • id string Required
    • status string Required
    • increment_id string Required
    • order_id string Required
    • order_date string Required
    • date_requested string Required
    • customer_custom_email string Required
    • customer_firstname string Required
    • customer_lastname string
    • date_received string
    • date_processed string
    • is_received_email_sent boolean Required
    • is_return_center boolean Required
    • items array[object] Required
      Hide items attributes Show items attributes object
      • is_qty_decimal boolean Required
      • qty_requested string Required
      • qty_authorized string
      • qty_approved string Required
      • status string Required
      • order_item_id string Required
      • product_name string Required
      • product_sku string Required
      • qty_returned string
      • product_admin_name string Required
      • product_admin_sku string Required
      • product_options string
      • product_color string
      • product_size string
      • product_merchant_code string
      • product_merchant_name string
      • product_manufacturer_code string
      • product_manufacturer_name string
      • exchange_size string
      • reason string
      • resolution string
      • merchant_resolution string
      • condition string
  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        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

      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

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        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

      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/user/rma/{rmaIncrementId}
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/user/rma/{rmaIncrementId}'
Response examples (200)
{
  "id": "string",
  "status": "string",
  "increment_id": "string",
  "order_id": "string",
  "order_date": "string",
  "date_requested": "string",
  "customer_custom_email": "string",
  "customer_firstname": "string",
  "customer_lastname": "string",
  "date_received": "string",
  "date_processed": "string",
  "is_received_email_sent": true,
  "is_return_center": true,
  "items": [
    {
      "is_qty_decimal": true,
      "qty_requested": "string",
      "qty_authorized": "string",
      "qty_approved": "string",
      "status": "string",
      "order_item_id": "string",
      "product_name": "string",
      "product_sku": "string",
      "qty_returned": "string",
      "product_admin_name": "string",
      "product_admin_sku": "string",
      "product_options": "string",
      "product_color": "string",
      "product_size": "string",
      "product_merchant_code": "string",
      "product_merchant_name": "string",
      "product_manufacturer_code": "string",
      "product_manufacturer_name": "string",
      "exchange_size": "string",
      "reason": "string",
      "resolution": "string",
      "merchant_resolution": "string",
      "condition": "string"
    }
  ]
}
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"
}