Create an RMA

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/return_merchandise_authorisations" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "return_merchandise_authorisation": {
      "sale_invoice": {
        "id": "INVOICE_INTERNAL_ID"
      },
      "returns": [
        {
          "sale_invoice_line": "INVOICE_LINE_ID",
          "rma_quantity": 1
        }
      ]
    }
  }'

from exsited import build_client

client = build_client()

response = (
    client.return_merchandise_authorisations.create_return_merchandise_authorisation(
        {
            "return_merchandise_authorisation": {
                "sale_invoice": {"id": "INVOICE_INTERNAL_ID"},
                "returns": [
                    {"sale_invoice_line": "INVOICE_LINE_ID", "rma_quantity": 1}
                ],
            }
        }
    )
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.returnMerchandiseAuthorisations.createReturnMerchandiseAuthorisation({
    return_merchandise_authorisation: {
        sale_invoice: {id: 'INVOICE_INTERNAL_ID'},
        returns: [{sale_invoice_line: 'INVOICE_LINE_ID', rma_quantity: 1}],
    },
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->returnMerchandiseAuthorisations->createReturnMerchandiseAuthorisation([
    'return_merchandise_authorisation' => [
        'sale_invoice' => ['id' => 'INVOICE_INTERNAL_ID'],
        'returns' => [['sale_invoice_line' => 'INVOICE_LINE_ID', 'rma_quantity' => 1]],
    ],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.return_merchandise_authorisations.return_merchandise_authorisations_dto.ReturnMerchandiseAuthorisationsDto;
import java.util.List;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ReturnMerchandiseAuthorisationsDto.ReturnMerchandiseAuthorisations> response = client.returnMerchandiseAuthorisations().createReturnMerchandiseAuthorisation(
        Map.of(
                "return_merchandise_authorisation", Map.of(
                        "sale_invoice", Map.of("id", "INVOICE_INTERNAL_ID"),
                        "returns", List.of(
                                Map.of("sale_invoice_line", "INVOICE_LINE_ID", "rma_quantity", 1)))));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReturnMerchandiseAuthorisations.CreateReturnMerchandiseAuthorisationAsync(new Dictionary<string, object?>
{
    ["return_merchandise_authorisation"] = new Dictionary<string, object?>
    {
        ["sale_invoice"] = new Dictionary<string, object?>
        {
            ["id"] = "INVOICE_INTERNAL_ID",
        },
        ["returns"] = new List<object?>
        {
            new Dictionary<string, object?>
            {
                ["sale_invoice_line"] = "INVOICE_LINE_ID",
                ["rma_quantity"] = 1,
            },
        },
    },
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.returnMerchandiseAuthorisations
    .createReturnMerchandiseAuthorisation({
      'return_merchandise_authorisation': {
        'sale_invoice': {'id': 'INVOICE_INTERNAL_ID'},
        'returns': [
          {'sale_invoice_line': 'INVOICE_LINE_ID', 'rma_quantity': 1},
        ],
      },
    });
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().CreateReturnMerchandiseAuthorisation(context.Background(), map[string]any{
	"return_merchandise_authorisation": map[string]any{
		"sale_invoice": map[string]any{"id": "INVOICE_INTERNAL_ID"},
		"returns": []any{
			map[string]any{
				"sale_invoice_line": "INVOICE_LINE_ID",
				"rma_quantity":      1,
			},
		},
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "return_merchandise_authorisation": {
    "activity_logs": "<array>",
    "code": "<string>",
    "href": "<string>",
    "id": "<string>",
    "object": "<string>",
    "status": "<string>",
    "version": 123
  }
}

POST

return_merchandise_authorisations

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/return_merchandise_authorisations" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "return_merchandise_authorisation": {
      "sale_invoice": {
        "id": "INVOICE_INTERNAL_ID"
      },
      "returns": [
        {
          "sale_invoice_line": "INVOICE_LINE_ID",
          "rma_quantity": 1
        }
      ]
    }
  }'

from exsited import build_client

client = build_client()

response = (
    client.return_merchandise_authorisations.create_return_merchandise_authorisation(
        {
            "return_merchandise_authorisation": {
                "sale_invoice": {"id": "INVOICE_INTERNAL_ID"},
                "returns": [
                    {"sale_invoice_line": "INVOICE_LINE_ID", "rma_quantity": 1}
                ],
            }
        }
    )
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.returnMerchandiseAuthorisations.createReturnMerchandiseAuthorisation({
    return_merchandise_authorisation: {
        sale_invoice: {id: 'INVOICE_INTERNAL_ID'},
        returns: [{sale_invoice_line: 'INVOICE_LINE_ID', rma_quantity: 1}],
    },
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->returnMerchandiseAuthorisations->createReturnMerchandiseAuthorisation([
    'return_merchandise_authorisation' => [
        'sale_invoice' => ['id' => 'INVOICE_INTERNAL_ID'],
        'returns' => [['sale_invoice_line' => 'INVOICE_LINE_ID', 'rma_quantity' => 1]],
    ],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.return_merchandise_authorisations.return_merchandise_authorisations_dto.ReturnMerchandiseAuthorisationsDto;
import java.util.List;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ReturnMerchandiseAuthorisationsDto.ReturnMerchandiseAuthorisations> response = client.returnMerchandiseAuthorisations().createReturnMerchandiseAuthorisation(
        Map.of(
                "return_merchandise_authorisation", Map.of(
                        "sale_invoice", Map.of("id", "INVOICE_INTERNAL_ID"),
                        "returns", List.of(
                                Map.of("sale_invoice_line", "INVOICE_LINE_ID", "rma_quantity", 1)))));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReturnMerchandiseAuthorisations.CreateReturnMerchandiseAuthorisationAsync(new Dictionary<string, object?>
{
    ["return_merchandise_authorisation"] = new Dictionary<string, object?>
    {
        ["sale_invoice"] = new Dictionary<string, object?>
        {
            ["id"] = "INVOICE_INTERNAL_ID",
        },
        ["returns"] = new List<object?>
        {
            new Dictionary<string, object?>
            {
                ["sale_invoice_line"] = "INVOICE_LINE_ID",
                ["rma_quantity"] = 1,
            },
        },
    },
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.returnMerchandiseAuthorisations
    .createReturnMerchandiseAuthorisation({
      'return_merchandise_authorisation': {
        'sale_invoice': {'id': 'INVOICE_INTERNAL_ID'},
        'returns': [
          {'sale_invoice_line': 'INVOICE_LINE_ID', 'rma_quantity': 1},
        ],
      },
    });
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().CreateReturnMerchandiseAuthorisation(context.Background(), map[string]any{
	"return_merchandise_authorisation": map[string]any{
		"sale_invoice": map[string]any{"id": "INVOICE_INTERNAL_ID"},
		"returns": []any{
			map[string]any{
				"sale_invoice_line": "INVOICE_LINE_ID",
				"rma_quantity":      1,
			},
		},
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "return_merchandise_authorisation": {
    "activity_logs": "<array>",
    "code": "<string>",
    "href": "<string>",
    "id": "<string>",
    "object": "<string>",
    "status": "<string>",
    "version": 123
  }
}

Send sale_invoice.id and the returns lines under return_merchandise_authorisation. The invoice must have fulfilled stock, and each return names a fulfilled invoice line and a quantity. The new RMA has status active and return_status pending.

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.

Body

application/json

return_merchandise_authorisation

object

required

Show child attributes

Response

201 - application/json

The new RMA's id, code, status and version, under return_merchandise_authorisation.

return_merchandise_authorisation

object

required

Show child attributes

Guides

API reference

Authorizations

Body

Response