Magento2
GET /V1/stock-hub/rma/{rmaIncrementId}

Get a specific return

Path parameters

  • rmaIncrementId string Required

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • increment_id string Required

      RMA increment id

    • order_increment_id string Required

      Order_increment_id

    • date_requested string Required

      Date_requested

    • items array[object] Required

      Items

      Hide items attributes Show items attributes object

      RMA item entity

      • id integer Required

        Id of RMA item

      • sku string Required
      • resolution string Required

        Resolution desired by customer

      • reason string

        Reason of return

      • qty_requested integer Required

        Number of items requested to be return

      • qty_approved integer

        Number of items approved by merchant. When the value is absent or null the merchant has not yet approved any items.

      • qty_returned integer

        Number of items returned to merchant. When the value is absent or null the merchant has not received any items.

      • manufacturer string

        Manufacturer

      • color string

        Color

      • size string

        Size

      • mpn string

        Manufacturer product number

      • merchant_product_reference string

        Merchant product number.

      • merchant_resolution string

        Merchant resolution.

      • parent_sku string

        Parent SKU

      • item_return_fee number Required

        Return fee for single item.

      • row_line_return_fee number Required

        Return fee for row line (number of requested items * return item fee)

    • status string Required

      Status

    • track object
      Hide track attributes Show track attributes object
      • tracking_number string Required

        Tracking number

      • carrier string Required

        Carrier code

      • method string

        Carrier method

      • tracking_url string

        Tracking URL

    • date_received string

      Datetime received by merchant. When value is null or absent the RMA has not been received by the merchant.

    • date_processed string

      Datetime processed by merchant. When value is null or absent the RMA has not been processed by the merchant.

    • currency string Required

      Currency code

    Hide response attributes Show response attributes object
    • increment_id string Required

      RMA increment id

    • order_increment_id string Required

      Order_increment_id

    • date_requested string Required

      Date_requested

    • items array[object] Required

      Items

      Hide items attributes Show items attributes object

      RMA item entity

      • id integer Required

        Id of RMA item

      • sku string Required
      • resolution string Required

        Resolution desired by customer

      • reason string

        Reason of return

      • qty_requested integer Required

        Number of items requested to be return

      • qty_approved integer

        Number of items approved by merchant. When the value is absent or null the merchant has not yet approved any items.

      • qty_returned integer

        Number of items returned to merchant. When the value is absent or null the merchant has not received any items.

      • manufacturer string

        Manufacturer

      • color string

        Color

      • size string

        Size

      • mpn string

        Manufacturer product number

      • merchant_product_reference string

        Merchant product number.

      • merchant_resolution string

        Merchant resolution.

      • parent_sku string

        Parent SKU

      • item_return_fee number Required

        Return fee for single item.

      • row_line_return_fee number Required

        Return fee for row line (number of requested items * return item fee)

    • status string Required

      Status

    • track object
      Hide track attributes Show track attributes object
      • tracking_number string Required

        Tracking number

      • carrier string Required

        Carrier code

      • method string

        Carrier method

      • tracking_url string

        Tracking URL

    • date_received string

      Datetime received by merchant. When value is null or absent the RMA has not been received by the merchant.

    • date_processed string

      Datetime processed by merchant. When value is null or absent the RMA has not been processed by the merchant.

    • currency string Required

      Currency code
  • 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/stock-hub/rma/{rmaIncrementId} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/stock-hub/rma/{rmaIncrementId}'
Response examples (200) 
{
  "increment_id": "string",
  "order_increment_id": "string",
  "date_requested": "string",
  "items": [
    {
      "id": 42,
      "sku": "string",
      "resolution": "string",
      "reason": "string",
      "qty_requested": 42,
      "qty_approved": 42,
      "qty_returned": 42,
      "manufacturer": "string",
      "color": "string",
      "size": "string",
      "mpn": "string",
      "merchant_product_reference": "string",
      "merchant_resolution": "string",
      "parent_sku": "string",
      "item_return_fee": 42.0,
      "row_line_return_fee": 42.0
    }
  ],
  "status": "string",
  "track": {
    "tracking_number": "string",
    "carrier": "string",
    "method": "string",
    "tracking_url": "string"
  },
  "date_received": "string",
  "date_processed": "string",
  "currency": "string"
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <increment-id>string</increment-id>
  <order-increment-id>string</order-increment-id>
  <date-requested>string</date-requested>
  <items type="array">
    <item>
      <id type="integer">42</id>
      <sku>string</sku>
      <resolution>string</resolution>
      <reason>string</reason>
      <qty-requested type="integer">42</qty-requested>
      <qty-approved type="integer">42</qty-approved>
      <qty-returned type="integer">42</qty-returned>
      <manufacturer>string</manufacturer>
      <color>string</color>
      <size>string</size>
      <mpn>string</mpn>
      <merchant-product-reference>string</merchant-product-reference>
      <merchant-resolution>string</merchant-resolution>
      <parent-sku>string</parent-sku>
      <item-return-fee type="float">42.0</item-return-fee>
      <row-line-return-fee type="float">42.0</row-line-return-fee>
    </item>
  </items>
  <status>string</status>
  <track>
    <tracking-number>string</tracking-number>
    <carrier>string</carrier>
    <method>string</method>
    <tracking-url>string</tracking-url>
  </track>
  <date-received>string</date-received>
  <date-processed>string</date-processed>
  <currency>string</currency>
</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>