Magento2
GET /V1/stock-hub/rma

List all 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
      Hide items attributes Show items attributes object

      RMA entity

      • 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

    • search_criteria object Required

      Search criteria interface.

      Hide search_criteria attributes Show search_criteria attributes object
      • filter_groups array[object] Required

        A list of filter groups.

        Hide filter_groups attribute Show filter_groups attribute object

        Groups two or more filters together using a logical OR

        • filters array[object]

          A list of filters in this group

          Hide filters attributes Show filters attributes object

          Filter which can be used by any methods from service layer.

          • field string Required

            Field

          • value string Required

            Value

          • condition_type string

            Condition type

      • sort_orders array[object]

        Sort order.

        Hide sort_orders attributes Show sort_orders attributes object

        Data object for sort order.

        • 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.

    Hide response attributes Show response attributes object
    • items array[object] Required
      Hide items attributes Show items attributes object

      RMA entity

      • 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

    • search_criteria object Required

      Search criteria interface.

      Hide search_criteria attributes Show search_criteria attributes object
      • filter_groups array[object] Required

        A list of filter groups.

        Hide filter_groups attribute Show filter_groups attribute object

        Groups two or more filters together using a logical OR

        • filters array[object]

          A list of filters in this group

          Hide filters attributes Show filters attributes object

          Filter which can be used by any methods from service layer.

          • field string Required

            Field

          • value string Required

            Value

          • condition_type string

            Condition type

      • sort_orders array[object]

        Sort order.

        Hide sort_orders attributes Show sort_orders attributes object

        Data object for sort order.

        • 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]

      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 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/stock-hub/rma'
Response examples (200) 
{
  "items": [
    {
      "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"
    }
  ],
  "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 (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <items type="array">
    <item>
      <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>
    </item>
  </items>
  <search-criteria>
    <filter-groups type="array">
      <filter-group>
        <filters type="array">
          <filter>
            <field>string</field>
            <value>string</value>
            <condition-type>string</condition-type>
          </filter>
        </filters>
      </filter-group>
    </filter-groups>
    <sort-orders type="array">
      <sort-order>
        <field>string</field>
        <direction>string</direction>
      </sort-order>
    </sort-orders>
    <page-size type="integer">42</page-size>
    <current-page type="integer">42</current-page>
  </search-criteria>
  <total-count type="integer">42</total-count>
</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>