Create VAS by return inventory ID

curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "createVasList": [
    {
      "returnInventoryId": "<string>",
      "createVasDetailList": [
        {
          "vasCode": "<string>",
          "notes": "<string>",
          "metaQuantity": 123,
          "vasFileList": [
            {
              "filename": "<string>",
              "fileKey": "<string>"
            }
          ]
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId"

payload = { "createVasList": [
        {
            "returnInventoryId": "<string>",
            "createVasDetailList": [
                {
                    "vasCode": "<string>",
                    "notes": "<string>",
                    "metaQuantity": 123,
                    "vasFileList": [
                        {
                            "filename": "<string>",
                            "fileKey": "<string>"
                        }
                    ]
                }
            ]
        }
    ] }
headers = {
    "x-rr-apikey": "<api-key>",
    "x-rr-apitoken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-rr-apikey': '<api-key>',
    'x-rr-apitoken': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    createVasList: [
      {
        returnInventoryId: '<string>',
        createVasDetailList: [
          {
            vasCode: '<string>',
            notes: '<string>',
            metaQuantity: 123,
            vasFileList: [{filename: '<string>', fileKey: '<string>'}]
          }
        ]
      }
    ]
  })
};

fetch('https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'createVasList' => [
        [
                'returnInventoryId' => '<string>',
                'createVasDetailList' => [
                                [
                                                                'vasCode' => '<string>',
                                                                'notes' => '<string>',
                                                                'metaQuantity' => 123,
                                                                'vasFileList' => [
                                                                                                                                [
                                                                                                                                                                                                                                                                'filename' => '<string>',
                                                                                                                                                                                                                                                                'fileKey' => '<string>'
                                                                                                                                ]
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-rr-apikey: <api-key>",
    "x-rr-apitoken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId"

	payload := strings.NewReader("{\n  \"createVasList\": [\n    {\n      \"returnInventoryId\": \"<string>\",\n      \"createVasDetailList\": [\n        {\n          \"vasCode\": \"<string>\",\n          \"notes\": \"<string>\",\n          \"metaQuantity\": 123,\n          \"vasFileList\": [\n            {\n              \"filename\": \"<string>\",\n              \"fileKey\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-rr-apikey", "<api-key>")
	req.Header.Add("x-rr-apitoken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId")
  .header("x-rr-apikey", "<api-key>")
  .header("x-rr-apitoken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"createVasList\": [\n    {\n      \"returnInventoryId\": \"<string>\",\n      \"createVasDetailList\": [\n        {\n          \"vasCode\": \"<string>\",\n          \"notes\": \"<string>\",\n          \"metaQuantity\": 123,\n          \"vasFileList\": [\n            {\n              \"filename\": \"<string>\",\n              \"fileKey\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"createVasList\": [\n    {\n      \"returnInventoryId\": \"<string>\",\n      \"createVasDetailList\": [\n        {\n          \"vasCode\": \"<string>\",\n          \"notes\": \"<string>\",\n          \"metaQuantity\": 123,\n          \"vasFileList\": [\n            {\n              \"filename\": \"<string>\",\n              \"fileKey\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "returnRequestLineItemId": 123,
      "createVasDetailList": [
        {}
      ]
    }
  ]
}

{
  "correlationId": "<string>",
  "meta": {
    "status": 123,
    "data": {},
    "errorCode": "<string>",
    "error": {}
  }
}

POST

api

Vas

CreateByReturnInventoryId

Create VAS by return inventory ID

curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "createVasList": [
    {
      "returnInventoryId": "<string>",
      "createVasDetailList": [
        {
          "vasCode": "<string>",
          "notes": "<string>",
          "metaQuantity": 123,
          "vasFileList": [
            {
              "filename": "<string>",
              "fileKey": "<string>"
            }
          ]
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId"

payload = { "createVasList": [
        {
            "returnInventoryId": "<string>",
            "createVasDetailList": [
                {
                    "vasCode": "<string>",
                    "notes": "<string>",
                    "metaQuantity": 123,
                    "vasFileList": [
                        {
                            "filename": "<string>",
                            "fileKey": "<string>"
                        }
                    ]
                }
            ]
        }
    ] }
headers = {
    "x-rr-apikey": "<api-key>",
    "x-rr-apitoken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-rr-apikey': '<api-key>',
    'x-rr-apitoken': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    createVasList: [
      {
        returnInventoryId: '<string>',
        createVasDetailList: [
          {
            vasCode: '<string>',
            notes: '<string>',
            metaQuantity: 123,
            vasFileList: [{filename: '<string>', fileKey: '<string>'}]
          }
        ]
      }
    ]
  })
};

fetch('https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'createVasList' => [
        [
                'returnInventoryId' => '<string>',
                'createVasDetailList' => [
                                [
                                                                'vasCode' => '<string>',
                                                                'notes' => '<string>',
                                                                'metaQuantity' => 123,
                                                                'vasFileList' => [
                                                                                                                                [
                                                                                                                                                                                                                                                                'filename' => '<string>',
                                                                                                                                                                                                                                                                'fileKey' => '<string>'
                                                                                                                                ]
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-rr-apikey: <api-key>",
    "x-rr-apitoken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId"

	payload := strings.NewReader("{\n  \"createVasList\": [\n    {\n      \"returnInventoryId\": \"<string>\",\n      \"createVasDetailList\": [\n        {\n          \"vasCode\": \"<string>\",\n          \"notes\": \"<string>\",\n          \"metaQuantity\": 123,\n          \"vasFileList\": [\n            {\n              \"filename\": \"<string>\",\n              \"fileKey\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-rr-apikey", "<api-key>")
	req.Header.Add("x-rr-apitoken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId")
  .header("x-rr-apikey", "<api-key>")
  .header("x-rr-apitoken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"createVasList\": [\n    {\n      \"returnInventoryId\": \"<string>\",\n      \"createVasDetailList\": [\n        {\n          \"vasCode\": \"<string>\",\n          \"notes\": \"<string>\",\n          \"metaQuantity\": 123,\n          \"vasFileList\": [\n            {\n              \"filename\": \"<string>\",\n              \"fileKey\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.returnshelper.com/uat/user/api/Vas/CreateByReturnInventoryId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"createVasList\": [\n    {\n      \"returnInventoryId\": \"<string>\",\n      \"createVasDetailList\": [\n        {\n          \"vasCode\": \"<string>\",\n          \"notes\": \"<string>\",\n          \"metaQuantity\": 123,\n          \"vasFileList\": [\n            {\n              \"filename\": \"<string>\",\n              \"fileKey\": \"<string>\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "returnRequestLineItemId": 123,
      "createVasDetailList": [
        {}
      ]
    }
  ]
}

{
  "correlationId": "<string>",
  "meta": {
    "status": 123,
    "data": {},
    "errorCode": "<string>",
    "error": {}
  }
}

Requests one or more value-added services (VAS) on received return inventory — quality inspection, repackaging, photo, split-parcel, etc. The warehouse executes the VAS and reports results back via subsequent webhook events.

Prerequisites

Target inventory items exist and belong to your account. The returnInventoryId values come from the newInventoryCreated webhook event — cache them on your side as parcels are logged.
Each target inventory’s handlingCode must be ohd (on-hold). VAS is only allowed while the inventory is on-hold; if it’s already in another handling pathway, move it back to on-hold first via Update return inventory handling.
Pick valid vasCode values from Get all VAS.

Required fields

createVasList — non-empty list of payloads. Each payload covers one inventory and one or more VAS requests on it.

Per payload:

returnInventoryId — string that parses to a long; must exist and be on-hold.
createVasDetailList — list of VAS detail objects, each carrying a vasCode and any VAS-specific fields.

returnInventoryId values across the whole batch must be unique — you cannot create two payloads for the same inventory in one call.

Split-parcel rule

If any VAS in a payload uses vasCode: SPLIT_PARCEL:

It must be the only VAS in that payload’s createVasDetailList (you can’t combine split-parcel with other VAS in a single payload for the same inventory).
File attachments are allowed (and typically required) only for SPLIT_PARCEL. Other VAS codes cannot have file attachments.

This is enforced because split-parcel changes the physical inventory shape; bundling it with other VAS would create ambiguity about ordering.

Side effects

The inventory’s handling stays at ohd while VAS is pending.
Subsequent webhook events report progress: vasUpdated, , splitLineItem and newInventoryCreated (For parcel split).
For split-parcel VAS, completion may produce additional inventory records (the split items).

Get all VAS — valid vasCode values.
Get all VAS statuses — code-to-label mappings for VAS lifecycle.
Update return inventory handling — move an inventory back to ohd if it’s left that state.
Webhooks — the vasUpdated event reports VAS lifecycle progress to your endpoint.

Authorizations

x-rr-apikey

string

header

required

Your API key

x-rr-apitoken

string

header

required

Your API token — keep this private

Body

application/json

createVasList

object[]

required

List of VAS creation payloads grouped by return inventory ID

Show child attributes

Response

Success

data

object[]

List of created VAS

Show child attributes

Overview

Api

FBA

Consolidate Shipping

Notification

Recall

Resend

ReturnInventory

ReturnShipment

ServiceType

Shipment

ShipmentServiceType

Vas

Warehouse

Create VAS by return inventory ID

Prerequisites

Required fields

Split-parcel rule

Side effects

Authorizations

Body

Response

​Prerequisites

​Required fields

​Split-parcel rule

​Side effects

​Related

Authorizations

Body

Response

Prerequisites

Required fields

Split-parcel rule

Side effects

Related