Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Sales Order

List sales orders

Returns a collection with all sales orders.

get/api/v1/salesOrders

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.

field'id' | 'documentNumber'
dir'asc' | 'desc'
key'orderDate' | 'status' | 'documentNumber' | 'transactionNumber' | 'externalOrderNumber' | 'customerOrderNumber' | 'externalOrderId' | 'customerId' | 'customerNumber' | 'email' | 'zipCode' | 'shippingEmail' | 'shippingZip' | 'isBeingEdited' | 'subsequentDelivery' | 'shippingDateOk' | 'creditLimitOk' | 'shippingLockOk' | 'prepaidOk' | 'postageOk' | 'customerCheckOk' | 'vatOk' | 'stockOk' | 'internalComment' | 'shippingMethod' | 'autoShipping' | 'fastLane' | 'gln' | 'shippingGln' | 'project' | 'paymentMethod' | 'country' | 'phoneNumber' | 'shippingCountry' | 'desiredDeliveryDate' | 'earliestFulfillmentDate' | 'createdAt' | 'updatedAt'
op'greaterThan' | 'lessThan' | 'greaterThanOrEquals' | 'lessThanOrEquals' | 'equals' | 'notEquals' | 'in' | 'notIn'

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "id": "1",
      "documentNumber": "SO1",
      "externalOrderNumber": "ES01",
      "transactionNumber": "transaction1",
      "customerOrderNumber": "customerOrder1",
      "externalOrderId": "10",
      "bodyOutroduction": "body",
      "date": "2024-01-01",
      "netSales": 620,
      "total": 737.8,
      "desiredDeliveryDate": "2022-12-05",
      "reservationDate": "2022-12-05",
      "desiredDeliveryDateAsCalendarWeek": false,
      "editor": "Administrator1",
      "sales": {
        "id": 17,
        "name": "John Doe"
      },
      "status": "created",
      "isBeingEdited": false,
      "subsequentDelivery": false,
      "shippingDateOk": true,
      "creditLimitOk": true,
      "shippingLockOk": true,
      "prepaidOk": true,
      "postageOk": true,
      "customerCheckOk": true,
      "vatOk": true,
      "stockOk": true,
      "customer": {
        "id": "1"
      },
      "comment": "Additional comments",
      "project": {
        "id": "1"
      },
      "language": {
        "iso2": "DE"
      },
      "log": {
        "createdAt": "2023-12-01T00:00:00Z",
        "createdBy": {
          "id": "1",
          "name": "User 1"
        }
      },
      "financials": {
        "paymentMethod": {
          "id": "3"
        },
        "currency": "EUR",
        "costCenter": {
          "id": "1",
          "number": "1234"
        },
        "billingAddress": {
          "type": "mr",
          "name": "John Doe",
          "department": "",
          "subDepartment": "",
          "street": "Musterstrasse 6",
          "zipCode": "12345",
          "city": "Musterdorf",
          "state": "",
          "country": "DE",
          "title": "",
          "contactPerson": "",
          "addressSupplement": "",
          "fax": "0821123456790",
          "email": "info@xentral.com",
          "salutation": "",
          "gln": "",
          "phoneNumber": "0123456789",
          "mobile": "0176987654"
        }
      },
      "delivery": {
        "autoShipping": true,
        "fastLane": true,
        "shippingCosts": [
          {
            "id": "1",
            "quantity": 3,
            "shippingCostProduct": {
              "id": "1"
            }
          }
        ],
        "preferredWarehouse": {
          "id": "1"
        },
        "storageCountry": "DE",
        "email": "user.email@email.org",
        "conditions": "none"
      },
      "createdAt": "2023-01-01T01:00:00+01:00",
      "updatedAt": "2023-01-01T01:00:00+01:00"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}