Skip to main content
GET
Get Return

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

returnId
string
required

Response

Returns the return for the given id.

Model Class: Return

Id
integer<int32>
required
Number
string
required

The number of the return.

Example:

"A1004465"

ReturnDate
string<date-time>
required

The date when the return was created.

Example:

"2023-02-01T12:45:00.0000000+00:00"

CustomerId
integer<int32>
required
ExternalNumber
string
required

An arbitrary external reference number for identifying the return, provided only during creation and cannot be changed afterward.

Example:

"EX-12345"

Origin
enum<integer>
required

0 = None, 1 = Email, 2 = Manual, 3 = Phone, 4 = Fax, 5 = FFN, 6 = SCX, 7 = RestAPI

Available options:
0,
1,
2,
3,
4,
5,
6,
7
CompanyId
integer<int32>
required
SalesOrderId
integer<int32>
required
StateId
integer<int32>
required
WarehouseId
integer<int32>
required
ExternalComment
string
required

The external comment of the sales order.

Example:

"a replacement is needed"

InternalComment
string
required

The internal comment of the sales order.

Example:

"handle with care"

Contact
string
required

The contact of the return.

Example:

"Mr. Robinson"