Process returned 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://merchant-order-fulfilment.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Merchant Order fulfilment API MCP server": {
    "url": "https://merchant-order-fulfilment.doc.winkelstraat.nl/mcp"
  }
}

POST /V2/winkelstraat/rma_api/shipment/{incrementId}

What it does. Records the received quantity, approval and condition of returned items on a shipment.

When to use. Use V3 Create a return for new integrations; kept for existing V2 consumers.

Version. RMA V2.

Path parameters

incrementId string Required

Shipment increment id.

Body

items array[object] Required

Returned items data.
Hide items attributes Show items attributes object
Interface ReturnItemInterface Defines the structure for managing return items, including their SKU, quantity, approval status, and condition.
- sku string Required
  
  Product SKU of the order/shipment item.
- qty_received integer
  
  Number of units physically received back.
- approved boolean
  
  Whether the received item is approved for refund/exchange.
- condition string
  
  Condition of the received item.
  
  Values are unworn, worn, damaged, counterfeit, wrong_item, or missing.
shipmentToken string Required

Shipment token. The shipment token is provided through the Shipment Push API.

Body

items array[object] Required

Returned items data.
Hide items attributes Show items attributes object
Interface ReturnItemInterface Defines the structure for managing return items, including their SKU, quantity, approval status, and condition.
- sku string Required
  
  Product SKU of the order/shipment item.
- qty_received integer
  
  Number of units physically received back.
- approved boolean
  
  Whether the received item is approved for refund/exchange.
- condition string
  
  Condition of the received item.
  
  Values are unworn, worn, damaged, counterfeit, wrong_item, or missing.
shipmentToken string Required

Shipment token. The shipment token is provided through the Shipment Push API.

Responses

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 /V2/winkelstraat/rma_api/shipment/{incrementId}

curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V2/winkelstraat/rma_api/shipment/{incrementId}' \
 --header "Content-Type: application/json" \
 --data '{"items":[{"sku":"WSNL123-BLACK-M","qty_received":1,"approved":true,"condition":"unworn"}],"shipmentToken":"string"}'

curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V2/winkelstraat/rma_api/shipment/{incrementId}' \
 --header "Content-Type: application/xml"

Request examples

{
  "items": [
    {
      "sku": "WSNL123-BLACK-M",
      "qty_received": 1,
      "approved": true,
      "condition": "unworn"
    }
  ],
  "shipmentToken": "string"
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <items type="array">
    <item>
      <sku>WSNL123-BLACK-M</sku>
      <qty-received type="integer">1</qty-received>
      <approved type="boolean">true</approved>
      <condition>unworn</condition>
    </item>
  </items>
  <shipmentToken>string</shipmentToken>
</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>