Post v1 winkelstraat creditmemo api shipment increment id deficiency

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

Path parameters

incrementId string Required

Body

uid string

Deprecated, use shipmentToken
shipmentToken string
items array[object]
Hide items attributes Show items attributes object
- sku string
- quantity integer

Responses

200

200 Success.
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  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 item
  
  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/creditmemo_api/shipment/{incrementId}/deficiency

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/winkelstraat/creditmemo_api/shipment/{incrementId}/deficiency' \
 --data '{"uid":"string","shipmentToken":"string","items":[{"sku":"string","quantity":42}]}'

Request examples

{
  "uid": "string",
  "shipmentToken": "string",
  "items": [
    {
      "sku": "string",
      "quantity": 42
    }
  ]
}

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"
}