Skip to main content
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>"
            }
          ]
        }
      ]
    }
  ]
}
'
{
  "data": [
    {
      "returnRequestLineItemId": 123,
      "createVasDetailList": [
        {}
      ]
    }
  ]
}
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).

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

Response

Success

​
data
object[]

List of created VAS