Create a return from a shipment increment id

POST /V3/winkelstraat/rma_api/shipment/{incrementId}

Create a return from a shipment increment id, and shipment item data. Requires a shipment token to authorize the request.

Path parameters

incrementId string Required

Shipment increment id.

Body

items array[object] Required

Returned items data.

Defines the structure for updating return items
Hide items attributes Show items attributes object
- sku string Required
- qty_requested integer
- reason string
shipmentToken string Required

Shipment token. The shipment token is provided through the Shipment Push API.
generateTrack boolean

Generate tracking number while creating return

Body

items array[object] Required

Returned items data.

Defines the structure for updating return items
Hide items attributes Show items attributes object
- sku string Required
- qty_requested integer
- reason string
shipmentToken string Required

Shipment token. The shipment token is provided through the Shipment Push API.
generateTrack boolean

Generate tracking number while creating return

Responses

200

application/json

application/json application/xml

200 Success.
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 /V3/winkelstraat/rma_api/shipment/{incrementId}

curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V3/winkelstraat/rma_api/shipment/{incrementId}' \
 --header "Content-Type: application/json" \
 --data '{"items":[{"sku":"string","qty_requested":42,"reason":"string"}],"shipmentToken":"string","generateTrack":true}'

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

Request examples

{
  "items": [
    {
      "sku": "string",
      "qty_requested": 42,
      "reason": "string"
    }
  ],
  "shipmentToken": "string",
  "generateTrack": true
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <items type="array">
    <item>
      <sku>string</sku>
      <qty-requested type="integer">42</qty-requested>
      <reason>string</reason>
    </item>
  </items>
  <shipmentToken>string</shipmentToken>
  <generateTrack type="boolean">true</generateTrack>
</root>

Response examples (200)

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

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>