Create an RMA note

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/return_merchandise_authorisations/RMA_ID/notes" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "note": {
      "note": "Box arrived damaged"
    }
  }'

from exsited import build_client

client = build_client()

response = client.return_merchandise_authorisations.create_return_merchandise_authorisation_note(
    "RMA_ID", {"note": {"note": "Box arrived damaged"}}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.returnMerchandiseAuthorisations.createReturnMerchandiseAuthorisationNote('RMA_ID', {
    note: {note: 'Box arrived damaged'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->returnMerchandiseAuthorisations->createReturnMerchandiseAuthorisationNote(
    'RMA_ID',
    ['note' => ['note' => 'Box arrived damaged']],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.returnMerchandiseAuthorisations().createReturnMerchandiseAuthorisationNote(
        "RMA_ID",
        Map.of("note", Map.of("note", "Box arrived damaged")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReturnMerchandiseAuthorisations.CreateReturnMerchandiseAuthorisationNoteAsync(
    "RMA_ID",
    new Dictionary<string, object?>
    {
        ["note"] = new Dictionary<string, object?>
        {
            ["note"] = "Box arrived damaged",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.returnMerchandiseAuthorisations
    .createReturnMerchandiseAuthorisationNote('RMA_ID', {
      'note': {'note': 'Box arrived damaged'},
    });
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.ReturnMerchandiseAuthorisations().CreateReturnMerchandiseAuthorisationNote(context.Background(), "RMA_ID", map[string]any{
	"note": map[string]any{"note": "Box arrived damaged"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

POST

return_merchandise_authorisations

{rma_id}

notes

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/return_merchandise_authorisations/RMA_ID/notes" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "note": {
      "note": "Box arrived damaged"
    }
  }'

from exsited import build_client

client = build_client()

response = client.return_merchandise_authorisations.create_return_merchandise_authorisation_note(
    "RMA_ID", {"note": {"note": "Box arrived damaged"}}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.returnMerchandiseAuthorisations.createReturnMerchandiseAuthorisationNote('RMA_ID', {
    note: {note: 'Box arrived damaged'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->returnMerchandiseAuthorisations->createReturnMerchandiseAuthorisationNote(
    'RMA_ID',
    ['note' => ['note' => 'Box arrived damaged']],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.returnMerchandiseAuthorisations().createReturnMerchandiseAuthorisationNote(
        "RMA_ID",
        Map.of("note", Map.of("note", "Box arrived damaged")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReturnMerchandiseAuthorisations.CreateReturnMerchandiseAuthorisationNoteAsync(
    "RMA_ID",
    new Dictionary<string, object?>
    {
        ["note"] = new Dictionary<string, object?>
        {
            ["note"] = "Box arrived damaged",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.returnMerchandiseAuthorisations
    .createReturnMerchandiseAuthorisationNote('RMA_ID', {
      'note': {'note': 'Box arrived damaged'},
    });
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.ReturnMerchandiseAuthorisations().CreateReturnMerchandiseAuthorisationNote(context.Background(), "RMA_ID", map[string]any{
	"note": map[string]any{"note": "Box arrived damaged"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Send JSON, not a form: {"note": {"note": "..."}}. This call takes no attachment.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

rma_id

string

required

The RMA's id, which starts with rma_. Its code is refused.

Body

application/json

note

object

required

Show child attributes

Response

201

The note is created.

Guides

API reference

Authorizations

Path Parameters

Body

Response