Sign in

v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
return

Query Returns

Query all returns

get/v2/returns

Query parameters

returnNumberstring

Search for a specific return number.

customerIdstring uuid

Represents a unique key for identifying a customer in the JTL system.

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

Gets the unique identifier for the customer.

IsExistingboolean

Gets a value indicating whether the customer key represents an existing customer.

salesOrderIdstring uuid
Example:b45f6432-2462-4c6f-b00f-1d9d01000000
returnStateIdstring uuid
Example:b45f6432-2462-4c6f-b00f-1d9d01000000
pageNumberinteger

Number of the page of items to fetch.

pageSizeinteger

Size of the page that is specified by pageNumber.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

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

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

Returns all non-pending returns.

totalItemsinteger

Gets or sets the total number of items available in the data source.

pageNumberinteger

Gets or sets the current page number in the paginated list.

pageSizeinteger

Gets or sets the number of items per page in the paginated list.

totalPagesinteger

Gets the total number of pages based on the total number of items and the page size.

hasPreviousPageboolean

Gets a value indicating whether there is a previous page available in the paginated list.

hasNextPageboolean

Gets a value indicating whether there is a next page available.

nextPageNumberinteger

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

previousPageNumberinteger

Gets the number of the previous page. If there is no previous page, it returns 1.

Example response

{
  "items": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "stateId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ]
}