Retrieve an RMA

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/return_merchandise_authorisations/RMA_ID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = (
    client.return_merchandise_authorisations.get_return_merchandise_authorisation(
        "RMA_ID"
    )
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.returnMerchandiseAuthorisations.getReturnMerchandiseAuthorisation('RMA_ID');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->returnMerchandiseAuthorisations->getReturnMerchandiseAuthorisation('RMA_ID');
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.ReturnMerchandiseAuthorisationRead;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ReturnMerchandiseAuthorisationRead> response = client.returnMerchandiseAuthorisations().getReturnMerchandiseAuthorisation(
        "RMA_ID");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReturnMerchandiseAuthorisations.GetReturnMerchandiseAuthorisationAsync("RMA_ID");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.returnMerchandiseAuthorisations
    .getReturnMerchandiseAuthorisation('RMA_ID');
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().GetReturnMerchandiseAuthorisation(context.Background(), "RMA_ID", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "return_merchandise_authorisation": {
    "account": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "name": "<string>",
      "object": "<string>"
    },
    "code": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "href": "<string>",
    "id": "<string>",
    "item_count": 123,
    "last_updated_by": null,
    "last_updated_on": null,
    "lines": "<array>",
    "note": "<string>",
    "object": "<string>",
    "receive_rmas": [
      {
        "code": "<string>",
        "created_by": {
          "name": "<string>",
          "object": "<string>"
        },
        "created_on": "<string>",
        "href": "<string>",
        "id": "<string>",
        "last_updated_by": null,
        "last_updated_on": null,
        "object": "<string>",
        "quantity_received": 123,
        "status": "<string>"
      }
    ],
    "return_status": "<string>",
    "rma_date": "<string>",
    "sale_invoice": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "sale_order": null,
    "status": "<string>",
    "version": 123,
    "warehouse": null
  }
}

GET

return_merchandise_authorisations

{rma_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/return_merchandise_authorisations/RMA_ID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = (
    client.return_merchandise_authorisations.get_return_merchandise_authorisation(
        "RMA_ID"
    )
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.returnMerchandiseAuthorisations.getReturnMerchandiseAuthorisation('RMA_ID');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->returnMerchandiseAuthorisations->getReturnMerchandiseAuthorisation('RMA_ID');
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.ReturnMerchandiseAuthorisationRead;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ReturnMerchandiseAuthorisationRead> response = client.returnMerchandiseAuthorisations().getReturnMerchandiseAuthorisation(
        "RMA_ID");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReturnMerchandiseAuthorisations.GetReturnMerchandiseAuthorisationAsync("RMA_ID");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.returnMerchandiseAuthorisations
    .getReturnMerchandiseAuthorisation('RMA_ID');
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().GetReturnMerchandiseAuthorisation(context.Background(), "RMA_ID", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "return_merchandise_authorisation": {
    "account": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "name": "<string>",
      "object": "<string>"
    },
    "code": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "href": "<string>",
    "id": "<string>",
    "item_count": 123,
    "last_updated_by": null,
    "last_updated_on": null,
    "lines": "<array>",
    "note": "<string>",
    "object": "<string>",
    "receive_rmas": [
      {
        "code": "<string>",
        "created_by": {
          "name": "<string>",
          "object": "<string>"
        },
        "created_on": "<string>",
        "href": "<string>",
        "id": "<string>",
        "last_updated_by": null,
        "last_updated_on": null,
        "object": "<string>",
        "quantity_received": 123,
        "status": "<string>"
      }
    ],
    "return_status": "<string>",
    "rma_date": "<string>",
    "sale_invoice": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "sale_order": null,
    "status": "<string>",
    "version": 123,
    "warehouse": null
  }
}

Returns the RMA under return_merchandise_authorisation, including its lines and the receipts of returned stock in receive_rmas.

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.

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_.

Response

200 - application/json

The RMA, under return_merchandise_authorisation.

return_merchandise_authorisation

object

required

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response