Magento2
GET /V1/returns/{id}

Return data object for specified RMA id

Path parameters

  • id integer Required

Responses

  • 200

    200 Success.

    Hide response attributes Show response 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

      Items

      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

      Comments list

      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]

        Custom attributes values.

        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

      Tracks list

      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]

      Custom attributes values.

      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

    Hide response attributes Show response 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

      Items

      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

      Comments list

      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]

        Custom attributes values.

        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

      Tracks list

      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]

      Custom attributes values.

      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]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        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 list

      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

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        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 list

      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]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        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 list

      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

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        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 list

      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
GET /V1/returns/{id} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/returns/{id}'
Response examples (200) 
{
  "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"
    }
  ]
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <increment-id>string</increment-id>
  <entity-id type="integer">42</entity-id>
  <order-id type="integer">42</order-id>
  <order-increment-id>string</order-increment-id>
  <store-id type="integer">42</store-id>
  <customer-id type="integer">42</customer-id>
  <date-requested>string</date-requested>
  <customer-custom-email>string</customer-custom-email>
  <items type="array">
    <item>
      <entity-id type="integer">42</entity-id>
      <rma-entity-id type="integer">42</rma-entity-id>
      <order-item-id type="integer">42</order-item-id>
      <qty-requested type="integer">42</qty-requested>
      <qty-authorized type="integer">42</qty-authorized>
      <qty-approved type="integer">42</qty-approved>
      <qty-returned type="integer">42</qty-returned>
      <reason>string</reason>
      <condition>string</condition>
      <resolution>string</resolution>
      <status>string</status>
      <extension-attributes>
        <merchant-resolution-code>string</merchant-resolution-code>
        <reason-code>string</reason-code>
        <resolution-code>string</resolution-code>
        <product-color>string</product-color>
        <product-size>string</product-size>
        <product-merchant-code>string</product-merchant-code>
        <product-merchant-name>string</product-merchant-name>
        <product-merchant-product-reference>string</product-merchant-product-reference>
        <product-manufacturer-code>string</product-manufacturer-code>
        <product-manufacturer-name>string</product-manufacturer-name>
        <exchange-size>string</exchange-size>
      </extension-attributes>
    </item>
  </items>
  <status>string</status>
  <comments type="array">
    <comment>
      <comment>string</comment>
      <rma-entity-id type="integer">42</rma-entity-id>
      <created-at>string</created-at>
      <entity-id type="integer">42</entity-id>
      <customer-notified type="boolean">true</customer-notified>
      <visible-on-front type="boolean">true</visible-on-front>
      <status>string</status>
      <admin type="boolean">true</admin>
      <extension-attributes>
      </extension-attributes>
      <custom-attributes type="array">
        <custom-attribute>
          <attribute-code>string</attribute-code>
          <value>string</value>
        </custom-attribute>
      </custom-attributes>
    </comment>
  </comments>
  <tracks type="array">
    <track>
      <entity-id type="integer">42</entity-id>
      <rma-entity-id type="integer">42</rma-entity-id>
      <track-number>string</track-number>
      <carrier-title>string</carrier-title>
      <carrier-code>string</carrier-code>
      <extension-attributes>
        <status>string</status>
        <delivery-time>string</delivery-time>
        <external-updated-at>string</external-updated-at>
        <label-filename>string</label-filename>
      </extension-attributes>
    </track>
  </tracks>
  <extension-attributes>
    <rma-return-address>
      <rma-id type="integer">42</rma-id>
      <name>string</name>
      <street>string</street>
      <city>string</city>
      <country-id>string</country-id>
      <postcode>string</postcode>
      <telephone>string</telephone>
      <email>string</email>
    </rma-return-address>
    <merchant-code>string</merchant-code>
    <date-received>string</date-received>
    <customer-firstname>string</customer-firstname>
    <customer-lastname>string</customer-lastname>
    <date-processed>string</date-processed>
    <shipping-address-customer-firstname>string</shipping-address-customer-firstname>
    <shipping-address-customer-lastname>string</shipping-address-customer-lastname>
  </extension-attributes>
  <custom-attributes type="array">
    <custom-attribute>
      <attribute-code>string</attribute-code>
      <value>string</value>
    </custom-attribute>
  </custom-attributes>
</root>
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 (401) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
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"
}
Response examples (default) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>