Mark order items deficient

POST /V2/winkelstraat/creditmemo_api/shipment/{incrementId}/deficiency

Mark order items deficient (not in stock), by providing a shipment increment id and a list of SKU with quantities deficient. A shipment token is required to authorize the request.

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
- quantity integer

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
- quantity integer

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
  
  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 /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":"string","quantity":42}]}'

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": "string",
      "quantity": 42
    }
  ]
}

Request examples

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