Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Return

List returns

Lists existing returns

get/api/v1/returns

Query parameters

numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

key'documentNumber' | 'customerId' | 'salesOrderId' | 'updatedAt' | 'createdAt'
op'equals' | 'in' | 'greaterThan' | 'notEquals' | 'lessThanOrEquals' | 'greaterThanOrEquals' | 'isOnOrBefore' | 'isOnOrAfter' | 'notIn' | 'contains'

Response

A list of returns

Example response

{
  "data": [
    {
      "id": "1",
      "date": "2023-03-16",
      "documentNumber": "2023-000001",
      "tags": [],
      "customer": {
        "id": "1",
        "number": "K-000001"
      },
      "salesOrder": {
        "id": "1"
      },
      "status": "completed",
      "progress": "checked",
      "shippingMethod": {
        "id": "1",
        "name": "DHL"
      },
      "project": {
        "id": "1",
        "name": "Standard Projekt"
      },
      "bodyOutroduction": "testfreitest",
      "internalComment": "testintern"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}