Report a deficient order

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/creditmemo_api/shipment/{incrementId}/deficiency

What it does. Reports the items that are short or damaged for a shipment and creates the corresponding credit memo(s). Returns the created credit memo increment ids.

When to use. Call this when goods arrive short or damaged and must be credited.

Version. Creditmemo V2 — recommended.

Path parameters

incrementId string Required

Shipment increment id.

Body

shipmentToken string Required

Shipment token. The shipment token is provided through the Shipment Push API..
items array[object]
Hide items attributes Show items attributes object
- sku string
  
  Product SKU of the order/shipment item.
- quantity integer
  
  Number of deficient (short/damaged) units to credit.

Body

shipmentToken string Required

Shipment token. The shipment token is provided through the Shipment Push API..
items array[object]
Hide items attributes Show items attributes object
- sku string
  
  Product SKU of the order/shipment item.
- quantity integer
  
  Number of deficient (short/damaged) units to credit.

Responses

200

application/json

application/json application/xml

200 Success.

list of created credit memo increment ids.

list of created credit memo increment ids.
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/creditmemo_api/shipment/{incrementId}/deficiency

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

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

Request examples

{
  "shipmentToken": "string",
  "items": [
    {
      "sku": "WSNL123-BLACK-M",
      "quantity": 1
    }
  ]
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <shipmentToken>string</shipmentToken>
  <items type="array">
    <item>
      <sku>WSNL123-BLACK-M</sku>
      <quantity type="integer">1</quantity>
    </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 (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>