List return orders V3

get

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

This endpoint requires the following scopes: return:read.

Paginated list of return orders.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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, isNull, isNotNull

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

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

writeProtection: equals, notEquals

address.id: equals, notEquals, in, notIn, isNull, isNotNull

project.id: equals, notEquals, in, notIn, isNull, isNotNull

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

tags.id: equals, notEquals, in, notIn, isNull, isNotNull

language: equals, notEquals, in, notIn

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

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

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

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

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

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

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

isDocumentSent: equals, notEquals

editor.id: equals, notEquals, in, notIn, isNull, isNotNull

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

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

lineItems.product.id: equals, notEquals, in, notIn, isNull, isNotNull

lineItems.number: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

status: equals, notEquals, in, notIn

sales.id: equals, notEquals, in, notIn, isNull, isNotNull

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

preferredWarehouse.id: equals, notEquals, in, notIn, isNull, isNotNull

shippingMethod.id: equals, notEquals, in, notIn, isNull, isNotNull

salesOrder.id: equals, notEquals, in, notIn, isNull, isNotNull

invoice.id: equals, notEquals, in, notIn, isNull, isNotNull

creditNote.id: equals, notEquals, in, notIn, isNull, isNotNull

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

supplierNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

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

string

Full-text-style search across id, documentNumber, documentDate, documentAddress.name, documentAddress.email, documentAddress.zipCode, customerNumber, internalDesignation, customerOrderNumber and lineItems.number.

include

array of strings

include

perPage

integer

≥ 0

Number of items per page. Default: 15, Max: 1000. A larger value is reduced to the maximum; omitting it or sending 0 selects the default.

page

integer

≥ 0

Page number. Only used with simple and table pagination. Omitting it or sending 0 selects the first page.

cursor

string

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

Headers

x-pagination

string

enum

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

Allowed:

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated list of return orders.

429Too Many Requests