List an RMA's receipts

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/return_merchandise_authorisations/RMA_CODE/receive?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.return_merchandise_authorisations.get_return_merchandise_authorisation_receive(
    "RMA_CODE", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.returnMerchandiseAuthorisations.getReturnMerchandiseAuthorisationReceive('RMA_CODE', {
    limit: 20,
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->returnMerchandiseAuthorisations->getReturnMerchandiseAuthorisationReceive(
    'RMA_CODE',
    ['limit' => 20],
);
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.InvoiceReturnMerchandiseAuthorisationReceiveList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<InvoiceReturnMerchandiseAuthorisationReceiveList> response = client.returnMerchandiseAuthorisations().getReturnMerchandiseAuthorisationReceive(
        "RMA_CODE",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReturnMerchandiseAuthorisations.GetReturnMerchandiseAuthorisationReceiveAsync(
    "RMA_CODE",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.returnMerchandiseAuthorisations
    .getReturnMerchandiseAuthorisationReceive(
      'RMA_CODE',
      queryParams: {'limit': 20},
    );
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().GetReturnMerchandiseAuthorisationReceive(context.Background(), "RMA_CODE", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {
      "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>"
    }
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

return_merchandise_authorisations

{rma_code}

receive

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/return_merchandise_authorisations/RMA_CODE/receive?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.return_merchandise_authorisations.get_return_merchandise_authorisation_receive(
    "RMA_CODE", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.returnMerchandiseAuthorisations.getReturnMerchandiseAuthorisationReceive('RMA_CODE', {
    limit: 20,
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->returnMerchandiseAuthorisations->getReturnMerchandiseAuthorisationReceive(
    'RMA_CODE',
    ['limit' => 20],
);
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.InvoiceReturnMerchandiseAuthorisationReceiveList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<InvoiceReturnMerchandiseAuthorisationReceiveList> response = client.returnMerchandiseAuthorisations().getReturnMerchandiseAuthorisationReceive(
        "RMA_CODE",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReturnMerchandiseAuthorisations.GetReturnMerchandiseAuthorisationReceiveAsync(
    "RMA_CODE",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.returnMerchandiseAuthorisations
    .getReturnMerchandiseAuthorisationReceive(
      'RMA_CODE',
      queryParams: {'limit': 20},
    );
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().GetReturnMerchandiseAuthorisationReceive(context.Background(), "RMA_CODE", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {
      "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>"
    }
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Returns the receipts of returned stock under data, each with its code, status and quantity_received. Use the RMA’s code in the path; its rma_ id returns 404. Other fields filter as filter_<field> for equality and filter_<field>_<operator> otherwise.

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.

Query Parameters

limit

integer

How many records to return on one page.

Example:

20

cursor

string

The next_cursor of the previous page, to read the page after it.

sort

string

The field to sort by. Prefix it with - for descending order, as in -created_on.

Example:

"-created_on"

Response

The receipts, under data.

object

string

url

string

data

object[]

Show child attributes

pagination

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Query Parameters

Response