Create a return for a specific order for the given set of items

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://magento2.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Magento2 MCP server": {
    "url": "https://magento2.doc.winkelstraat.nl/mcp"
  }
}

POST /V1/stock-hub/rma

Create a return for a specific order for the given set of items.

Body

orderIncrementId string Required
items array[object] Required
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)

Body

orderIncrementId string Required
items array[object] Required
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)

Responses

200

application/json

application/json application/xml

200 Success.
401

application/json

application/json application/xml

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

application/json

application/json application/xml

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

POST /V1/stock-hub/rma

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/stock-hub/rma' \
 --header "Content-Type: application/json" \
 --data '{"orderIncrementId":"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}]}'

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/stock-hub/rma' \
 --header "Content-Type: application/xml"

Request examples

{
  "orderIncrementId": "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
    }
  ]
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <orderIncrementId>string</orderIncrementId>
  <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>
</root>

Response examples (200)

[
  "string"
]

Response examples (200)

<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
  <root>string</root>
</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>