Post v1 winkelstraat rma api shipment increment

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

      
          mcp.json

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

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

Path parameters

incrementId string Required

Body

items array[object] Required
Hide items attributes Show items attributes object
- sku string Required
- qty_received integer Required
- approved boolean Required
- condition string Required
uid string

Deprecated, use shipmentToken
shipmentToken string

Body

items array[object] Required
Hide items attributes Show items attributes object
- sku string Required
- qty_received integer Required
- approved boolean Required
- condition string Required
uid string

Deprecated, use shipmentToken
shipmentToken string

Responses

200

application/json

application/json application/xml

200 Success.
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/winkelstraat/rma_api/shipment/{incrementId}

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/winkelstraat/rma_api/shipment/{incrementId}' \
 --header "Content-Type: application/json" \
 --data '{"items":[{"sku":"string","qty_received":42,"approved":true,"condition":"string"}],"uid":"string","shipmentToken":"string"}'

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

Request examples

{
  "items": [
    {
      "sku": "string",
      "qty_received": 42,
      "approved": true,
      "condition": "string"
    }
  ],
  "uid": "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>
      <approved type="boolean">true</approved>
      <condition>string</condition>
    </item>
  </items>
  <uid>string</uid>
  <shipmentToken>string</shipmentToken>
</root>

Response examples (200)

string

Response examples (200)

string

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>