Post v1 winkelstraat rma api shipment increment

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

Responses

200

200 Success.
default

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

curl \
 -X POST https://magento2.winkelstraat.mac/rest/all/V1/winkelstraat/rma_api/shipment/{incrementId} \
 -d '{"items":[{"sku":"string","qty_received":42,"approved":true,"condition":"string"}],"uid":"string","shipmentToken":"string"}'

Request examples

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