API Reference
GuidesAPI ReferenceRoadmap
API Reference
API Reference

List return orders V3

get
https://{xentralId}.xentral.biz/api/v3/returnOrders

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: return:read.

Paginated list of return orders.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
filter
array of objects

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

id: equals, notEquals, in, notIn

documentNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

writeProtection: equals, notEquals

address.id: equals, notEquals, in, notIn

project.id: equals, notEquals, in, notIn

tags: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

tags.id: equals, notEquals, in, notIn

language: equals, notEquals, in, notIn

bodyIntroduction: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

bodyOutroduction: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

project.abbreviation: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

internalDesignation: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

vatId: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryTerms: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

internalComment: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

isDocumentSent: equals, notEquals

createdAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

updatedAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

documentAddress.name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.title: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.contactPerson: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.department: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.subDepartment: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.addressSupplement: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.street: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.zipCode: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.city: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.state: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.country: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.gln: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.email: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.phone: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.fax: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

status: equals, notEquals, in, notIn

editor.id: equals, notEquals, in, notIn

sales.id: equals, notEquals, in, notIn

customerOrderNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

preferredWarehouse.id: equals, notEquals, in, notIn

shippingMethod.id: equals, notEquals, in, notIn

salesOrder.id: equals, notEquals, in, notIn

invoice.id: equals, notEquals, in, notIn

creditNote.id: equals, notEquals, in, notIn

customerNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

useAlternativeDocumentTitle: equals, notEquals

isReturnOrderToSupplier: equals, notEquals

progress: equals, notEquals, in, notIn

filter
sort
array

Sort via id, -id, documentNumber, -documentNumber, documentDate, -documentDate, customerNumber, -customerNumber, documentAddress.country, -documentAddress.country, project.id, -project.id, createdAt, -createdAt, updatedAt and -updatedAt. Default sort is id

sort
include
array of strings
include
integer

Number of items per page. Default: 15, Max: 1000

integer

Page number. Only used with simple and table pagination.

string

The cursor to use for the paginated call. Only used with cursor pagination. Not compatible with page parameter

Headers
string
enum

Controls the pagination format. Available types: simple, table, cursor. Defaults to 'simple' if not specified.

Allowed:
Responses

401

Unauthorized

403

Forbidden

Updated 15 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 15 days ago