Path parameters

• id string Required

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  Interface RmaInterface

  • 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

    Interface CategoryInterface

    • 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

    Interface CommentInterface

    • 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

      Interface for custom attribute value.

      • attribute_code string Required

        Attribute code

      • value string Required

        Attribute value

  • tracks array[object] Required

    Interface TrackInterface

    Hide tracks attributes Show tracks attributes object

    Interface TrackInterface

    • 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

    Interface for custom attribute value.

    • attribute_code string Required

      Attribute code

    • value string Required

      Attribute value

• 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

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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

    Error parameters item

    • 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

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace