Returns, by version or by seq

GET

/api/integration/v1/returns

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.slflo.com/api/integration/v1/returns?filter%5Bversion_after%5D=18000&filter%5Bupdated_after%5D=2026-10-01T00%3A00%3A00Z&filter%5Back%5D=pending&filter%5Bid%5D=ord_01J9X%2Cord_01J9Y&filter%5Bexternal_ref%5D=SO-0012345&per_page=100&filter%5Bseq_after%5D=40"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.slflo.com/api/integration/v1/returns?filter%5Bversion_after%5D=18000&filter%5Bupdated_after%5D=2026-10-01T00%3A00%3A00Z&filter%5Back%5D=pending&filter%5Bid%5D=ord_01J9X%2Cord_01J9Y&filter%5Bexternal_ref%5D=SO-0012345&per_page=100&filter%5Bseq_after%5D=40"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'https://api.slflo.com/api/integration/v1/returns?filter%5Bversion_after%5D=18000&filter%5Bupdated_after%5D=2026-10-01T00%3A00%3A00Z&filter%5Back%5D=pending&filter%5Bid%5D=ord_01J9X%2Cord_01J9Y&filter%5Bexternal_ref%5D=SO-0012345&per_page=100&filter%5Bseq_after%5D=40';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.slflo.com/api/integration/v1/returns?filter%5Bversion_after%5D=18000&filter%5Bupdated_after%5D=2026-10-01T00%3A00%3A00Z&filter%5Back%5D=pending&filter%5Bid%5D=ord_01J9X%2Cord_01J9Y&filter%5Bexternal_ref%5D=SO-0012345&per_page=100&filter%5Bseq_after%5D=40' \
  --header 'Authorization: Bearer <token>'

By version (every change, reversals included) or, with filter[seq_after], each return once as it is issued, with no gaps. Needs returns:read.

Authorizations

bearer

Parameters

Query Parameters

filter[version_after]

integer format: int64

The cursor: the last version you staged, or meta.next_version_after. version_after is accepted too.

Example

filter[updated_after]

string

ISO-8601 time; starts a first load at the first change from then. Not beside a cursor.

Example

2026-10-01T00:00:00Z

filter[ack]

string

Pending (no ack at the current version), accepted, rejected or any (default).

Example

pending

filter[id]

string

Comma list of our ids, at most 100.

Example

ord_01J9X,ord_01J9Y

filter[external_ref]

string

Your key for the record, as you acked it.

Example

SO-0012345

per_page

integer format: int64

1 to 500, default 100.

Example

filter[seq_after]

integer format: int64

Follow newly issued documents in issue order instead: the last seq you took (meta.last_seq). On its own.

Example

Responses

200

Returns, by version or by seq

application/json

object

data

required

Array<object>

object

ack

object

acked_at

required

string

acked_version

required

integer format: int64

external_number

string

external_ref

string

message

string

outcome

required

string

reason_code

string

approval

object

decided_at

string

decided_by

string

held_reason

string

note

string

branch

required

object

code

string

external_ref

string

required

string

credit_note_number

string

currency

required

string

customer

required

object

code

string

external_ref

string

required

string

external_number

string

external_ref

string

required

string

invoice

required

object

external_number

string

external_ref

string

required

string

number

required

string

seq

integer format: int64

lines

required

Array<object>

object

batch_id

string

invoice_line_number

required

integer format: int32

is_expired

required

boolean

line_number

required

integer format: int32

line_total

required

string

product

required

object

code

string

external_ref

string

required

string

quantity

required

string

unit

required

object

code

string

external_ref

string

required

string

unit_price

required

string

location

required

object

code

string

external_ref

string

required

string

number

required

string

reason

required

string

return_date

required

string

returned_at

required

string

sales_rep

required

object

code

string

external_ref

string

required

string

seq

integer format: int64

status

required

string

total

required

string

updated_at

required

string

version

required

integer format: int64

meta

required

One of:

object
object

object

has_more

required

boolean

high_water

required

integer format: int64

next_version_after

required

integer format: int64

per_page

required

integer format: int32

Example

{
  "data": [
    {
      "ack": null,
      "approval": null,
      "branch": {
        "code": "MAIN",
        "external_ref": "CUST-0042/01",
        "id": "C0000001:main"
      },
      "credit_note_number": "RET-000004",
      "currency": "EGP",
      "customer": {
        "code": "CUST-1",
        "external_ref": "CUST-0042",
        "id": "C0000001"
      },
      "external_number": null,
      "external_ref": null,
      "id": "ret_01J9",
      "invoice": {
        "external_number": "D365-INV-77",
        "external_ref": "D365-INV-77",
        "id": "inv_01J9",
        "number": "INV-000041",
        "seq": 41
      },
      "lines": [
        {
          "batch_id": null,
          "invoice_line_number": 1,
          "is_expired": false,
          "line_number": 1,
          "line_total": "251.00",
          "product": {
            "code": "SKU-COLA",
            "external_ref": "ITEM-1001",
            "id": "P0000001"
          },
          "quantity": "2.000",
          "unit": {
            "code": "CASE",
            "external_ref": "cs",
            "id": "CASE"
          },
          "unit_price": "125.50"
        }
      ],
      "location": {
        "code": "VAN-12",
        "external_ref": "VAN12",
        "id": "van_12"
      },
      "number": "RET-000004",
      "reason": "DAMAGED",
      "return_date": "2026-10-05",
      "returned_at": "2026-10-05T10:42:00Z",
      "sales_rep": {
        "code": "R012",
        "external_ref": "EMP-0451",
        "id": "rep_12"
      },
      "seq": 4,
      "status": "RECORDED",
      "total": "251.00",
      "updated_at": "2026-10-05T10:42:00Z",
      "version": 9140
    }
  ],
  "meta": {
    "has_more": false,
    "high_water": 9140,
    "next_version_after": 9140,
    "per_page": 100
  }
}

default

An error: the code says what, retryable whether to try again.

application/json

object

error

required

object

code

required

Stable code, e.g. SCOPE_MISSING, UNKNOWN_REFERENCE.

string

details

required

Field-level problems: {field, code}.

Array<object>

object

key

additional properties

string

message

required

What happened and how to fix it.

string

request_id

required

Quote it to support; it finds the server log.

string

retryable

required

Whether the same call may succeed later.

boolean

Example

{
  "error": {
    "code": "SCOPE_MISSING",
    "details": [],
    "message": "This client does not hold the invoices:read scope.",
    "request_id": "req_01J9X4Q7T2M8P3NRT6V5WZ",
    "retryable": false
  }
}