Process returned items by shipment increment id

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

      
          mcp.json

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

PUT /V3/winkelstraat/rma_api/rma/{incrementId}

Process returned items by shipment increment id, return items data. Requires a shipment token to authorize the request.

Path parameters

incrementId string Required

Shipment increment id.

Body

items array[object] Required

Returned items data.
Hide items attributes Show items attributes object
Defines the structure of return items for creating a return
- sku string Required
- qty_received integer
- qty_approved integer
- condition string
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
Defines the structure of return items for creating a return
- sku string Required
- qty_received integer
- qty_approved integer
- condition string
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

PUT /V3/winkelstraat/rma_api/rma/{incrementId}

curl \
 --request PUT 'https://m2.winkelstraat.nl/rest/all/V3/winkelstraat/rma_api/rma/{incrementId}' \
 --header "Content-Type: application/json" \
 --data '{"items":[{"sku":"string","qty_received":42,"qty_approved":42,"condition":"string"}],"shipmentToken":"string"}'

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

Request examples

{
  "items": [
    {
      "sku": "string",
      "qty_received": 42,
      "qty_approved": 42,
      "condition": "string"
    }
  ],
  "shipmentToken": "string"
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <items type="array">
    <item>
      <sku>string</sku>
      <qty-received type="integer">42</qty-received>
      <qty-approved type="integer">42</qty-approved>
      <condition>string</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>