Retrieve an RMA receipt

cURL

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

from exsited import build_client

client = build_client()

response = client.return_merchandise_authorisations.get_return_merchandise_authorisation_receive_by_uuid(
    "RMA_CODE", "RECEIPT_ID"
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.returnMerchandiseAuthorisations.getReturnMerchandiseAuthorisationReceiveByUuid(
    'RMA_CODE',
    'RECEIPT_ID',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->returnMerchandiseAuthorisations->getReturnMerchandiseAuthorisationReceiveByUuid(
    'RMA_CODE',
    'RECEIPT_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.InvoiceReturnMerchandiseAuthorisationReceive;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<InvoiceReturnMerchandiseAuthorisationReceive> response = client.returnMerchandiseAuthorisations().getReturnMerchandiseAuthorisationReceiveByUuid(
        "RMA_CODE",
        "RECEIPT_ID");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReturnMerchandiseAuthorisations.GetReturnMerchandiseAuthorisationReceiveByUuidAsync(
    "RMA_CODE",
    "RECEIPT_ID");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.returnMerchandiseAuthorisations
    .getReturnMerchandiseAuthorisationReceiveByUuid('RMA_CODE', 'RECEIPT_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().GetReturnMerchandiseAuthorisationReceiveByUUID(context.Background(), "RMA_CODE", "RECEIPT_ID", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "receive_rma": {
    "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>"
  }
}

GET

return_merchandise_authorisations

{rma_code}

receive

{receive_uuid}

cURL

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

from exsited import build_client

client = build_client()

response = client.return_merchandise_authorisations.get_return_merchandise_authorisation_receive_by_uuid(
    "RMA_CODE", "RECEIPT_ID"
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.returnMerchandiseAuthorisations.getReturnMerchandiseAuthorisationReceiveByUuid(
    'RMA_CODE',
    'RECEIPT_ID',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->returnMerchandiseAuthorisations->getReturnMerchandiseAuthorisationReceiveByUuid(
    'RMA_CODE',
    'RECEIPT_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.InvoiceReturnMerchandiseAuthorisationReceive;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<InvoiceReturnMerchandiseAuthorisationReceive> response = client.returnMerchandiseAuthorisations().getReturnMerchandiseAuthorisationReceiveByUuid(
        "RMA_CODE",
        "RECEIPT_ID");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReturnMerchandiseAuthorisations.GetReturnMerchandiseAuthorisationReceiveByUuidAsync(
    "RMA_CODE",
    "RECEIPT_ID");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.returnMerchandiseAuthorisations
    .getReturnMerchandiseAuthorisationReceiveByUuid('RMA_CODE', 'RECEIPT_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().GetReturnMerchandiseAuthorisationReceiveByUUID(context.Background(), "RMA_CODE", "RECEIPT_ID", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "receive_rma": {
    "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>"
  }
}

Use the RMA’s code in the path and the receipt’s rrma_ id or code. The receipt comes back with its status and quantity_received.

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_code

string

required

The RMA's code. Its rma_ id returns 404.

receive_uuid

string

required

The receipt's id, which starts with rrma_, or its code.

Response

200 - application/json

The receipt, under receive_rma.

receive_rma

object

required

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response