Send a creditmemo item webhook event trigger to the specified URL

POST /V1/winkelstraat/push_api/webhook-trigger/creditmemo-item

Send a creditmemo item webhook event trigger to the specified URL. Requires a SKU and creditmemo increment id for which the data is sent. Requires a valid shipment token as UID. The shipment token must be related to the shipment of the creditmemo. The configured API key will be used when no API key is provided.

Body

uid string Required

A valid shipment token. WS.NL will provide this value.
incrementId string Required

A valid creditmemo increment id. WS.NL will provide this value.
sku string Required

A SKU from the relating creditmemo. WS.NL will provide this value.
url string Required

The URL to which the data is sent.
apiKey string

The API key for authorization.

Body

uid string Required

A valid shipment token. WS.NL will provide this value.
incrementId string Required

A valid creditmemo increment id. WS.NL will provide this value.
sku string Required

A SKU from the relating creditmemo. WS.NL will provide this value.
url string Required

The URL to which the data is sent.
apiKey string

The API key for authorization.

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
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

POST /V1/winkelstraat/push_api/webhook-trigger/creditmemo-item

curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V1/winkelstraat/push_api/webhook-trigger/creditmemo-item' \
 --header "Content-Type: application/json" \
 --data '{"uid":"string","incrementId":"string","sku":"string","url":"string","apiKey":"string"}'

curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V1/winkelstraat/push_api/webhook-trigger/creditmemo-item' \
 --header "Content-Type: application/xml"

Request examples

{
  "uid": "string",
  "incrementId": "string",
  "sku": "string",
  "url": "string",
  "apiKey": "string"
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <uid>string</uid>
  <incrementId>string</incrementId>
  <sku>string</sku>
  <url>string</url>
  <apiKey>string</apiKey>
</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>