Post
/apps-order-service/api/orders/filter
Body parameters
object
id
integer (int64)
name
string
icon
string
domain
string
subject
string
source
string
Valid values[
"DRAFT",
"QUOTE",
"COMMITED",
"DELIVERED"
]
firstResult
integer (int32)
maxResults
integer (int32)
includeSeller
boolean
followupDateMissing
boolean
deliveryDateMissing
boolean
searchText
string
orderTypes
Array of string
string
orderTypesExcluded
Array of string
string
flowIndicators
Array of string
string
Valid values[
"DRAFT",
"QUOTE",
"COMMITED",
"DELIVERED"
]
flowIndicatorsExcluded
Array of string
string
Valid values[
"DRAFT",
"QUOTE",
"COMMITED",
"DELIVERED"
]
sellerNos
Array of string
string
sellerNosExcluded
Array of string
string
customerNos
Array of string
string
customerNosExcluded
Array of string
string
customerProjectNos
Array of string
string
customerProjectNosExcluded
Array of string
string
departmentNos
Array of string
string
departmentNosExcluded
Array of string
string
warehouseNos
Array of string
string
warehouseNosExcluded
Array of string
string
orderDate
object (apps-order-service_DateFilter)
fromAndIncluding
string (date-time)
toAndIncluding
string (date-time)
orderDateRelative
object (apps-order-service_RelativeDateFilter)
field
string
Valid values[
"RelativeDateField.DATE"
]
fromAndIncluding
integer (int32)
toAndIncluding
integer (int32)
followupDate
object (apps-order-service_DateFilter)
fromAndIncluding
string (date-time)
toAndIncluding
string (date-time)
followupDateRelative
object (apps-order-service_RelativeDateFilter)
field
string
Valid values[
"RelativeDateField.DATE"
]
fromAndIncluding
integer (int32)
toAndIncluding
integer (int32)
deliveryDate
object (apps-order-service_DateFilter)
fromAndIncluding
string (date-time)
toAndIncluding
string (date-time)
deliveryDateRelative
object (apps-order-service_RelativeDateFilter)
field
string
Valid values[
"RelativeDateField.DATE"
]
fromAndIncluding
integer (int32)
toAndIncluding
integer (int32)
coveragePercent
object (apps-order-service_DecimalFilter)
fromAndIncluding
number
toAndIncluding
number
sumOrderTotal
object (apps-order-service_DecimalFilter)
fromAndIncluding
number
toAndIncluding
number
sumOrderCost
object (apps-order-service_DecimalFilter)
fromAndIncluding
number
toAndIncluding
number
lastChangedTimestamp
object (apps-order-service_DateFilter)
fromAndIncluding
string (date-time)
toAndIncluding
string (date-time)
lastChangedTimestampRelative
object (apps-order-service_RelativeDateFilter)
field
string
Valid values[
"RelativeDateField.DATE"
]
fromAndIncluding
integer (int32)
toAndIncluding
integer (int32)
sortFields
Array of object (apps-order-service_SortField)
object
orderField
string
Valid values[
"ORDER_ID",
"ORDER_FLOW_INDICATOR",
"ORDER_TYPE",
"ORDER_NO",
"DELIVERY_METHOD",
"DELIVERY_TYPE",
"PURCHASE_ORDER_NUMBER",
"EXTERNAL_ORDER_NO",
"EXTERNAL_ORDER_STATUS",
"ORDER_DATE",
"DELIVERY_DATE",
"FOLLOWUP_DATE",
"WAREHOUSE_NO",
"CUSTOMER_NO",
"CUSTOMER_NAME",
"CUSTOMER_PROJECT_NO",
"CUSTOMER_PROJECT_NAME",
"SELLER_NO",
"SELLER_NAME",
"SUM_ORDER_TOTAL",
"SUM_ORDER_COST",
"COVERAGE_PERCENT",
"ORDER_INFO_CODE",
"CREATED",
"LAST_CHANGED"
]
sortType
string
Valid values[
"ASC",
"DESC"
]
selectFields
Array of string
string
Valid values[
"ORDER_ID",
"ORDER_FLOW_INDICATOR",
"ORDER_TYPE",
"ORDER_NO",
"DELIVERY_METHOD",
"DELIVERY_TYPE",
"PURCHASE_ORDER_NUMBER",
"EXTERNAL_ORDER_NO",
"EXTERNAL_ORDER_STATUS",
"ORDER_DATE",
"DELIVERY_DATE",
"FOLLOWUP_DATE",
"WAREHOUSE_NO",
"CUSTOMER_NO",
"CUSTOMER_NAME",
"CUSTOMER_PROJECT_NO",
"CUSTOMER_PROJECT_NAME",
"SELLER_NO",
"SELLER_NAME",
"SUM_ORDER_TOTAL",
"SUM_ORDER_COST",
"COVERAGE_PERCENT",
"ORDER_INFO_CODE",
"CREATED",
"LAST_CHANGED"
]
aggregateFields
Array of string
string
Valid values[
"ORDER_ID_COUNT",
"ORDER_TOTAL_EX_VAT_SUM",
"ORDER_TOTAL_EX_VAT_AVERAGE",
"ORDER_TOTAL_INC_VAT_SUM",
"ORDER_TOTAL_INC_VAT_AVERAGE",
"ORDER_COST_EX_VAT_SUM",
"ORDER_COST_EX_VAT_AVERAGE",
"COVERAGE_PERCENT_AVERAGE",
"MARGIN_SUM",
"MARGIN_AVERAGE"
]
forOrderTree
boolean
Responses
200
OK
object
entities
Array of object (apps-order-service_Order)
object
version
integer (int64)
orderFlowIndicator
string
Valid values[
"DRAFT",
"QUOTE",
"COMMITED",
"DELIVERED"
]
orderNo
integer (int64)
parentOrderNo
integer (int64)
externalOrderNo
string Deprecated
externalOrderStatus
string Deprecated
orderType
string Deprecated
externalOrderReferences
Array of object (apps-order-service_ExternalOrderReference)
object
externalSystemCode
string
externalOrderNo
string
externalOrderStatus
string
externalOrderType
string
departmentNo
string
warehouseNo
string
customer
object (apps-order-service_Customer)
customerNo
string
name
string
phone
string
mobile
string
fax
string
url
string
email
string
organizationNumber
string
defaultOrderDiscountPercent
number
vatFree
boolean
address
object (apps-order-service_Address)
name
string
address1
string
address2
string
postalCode
string
city
string
country
string
articleCustomer
object (apps-order-service_ArticleCustomer)
name
string
organizationNumber
string
gln
string
customerProject
object (apps-order-service_CustomerProject)
id
string
projectNo
string
name
string
externalProjectNo
string
email
string
phone
string
mobile
string
address
object (apps-order-service_Address)
name
string
address1
string
address2
string
postalCode
string
city
string
country
string
orderDate
string (date-time)
deliveryDate
string (date-time)
expireDate
string (date-time)
followupDate
string (date-time)
deliveryType
object (apps-order-service_DeliveryType)
code
string
name
string
deliveryRouteId
string
deliveryMethodId
string
ourReference
string
customerReference
string
requisition
string
information
string
salesperson
object (apps-order-service_Salesperson)
code
string
name
string
phone
string
email
string
responsibleSalesperson
object (apps-order-service_Salesperson)
code
string
name
string
phone
string
email
string
deliveryAddress
object (apps-order-service_Address)
name
string
address1
string
address2
string
postalCode
string
city
string
country
string
coveragePercent
number
orderDiscountPercent
number
totalPurchasePriceExVat
number
totalCostPriceExVat
number
totalDiscountedPriceExVat
number
totalDiscountedPriceIncVat
number
createdTimestamp
string (date-time)
createdByUser
string
lastChangedTimestamp
string (date-time)
lastChangedByUser
string
deletedByUser
string
deletedTime
string (date-time)
deletedReason
string
orderInfoCode
string
calculateVat
boolean
automaticFee
boolean
automaticInvoiceFee
boolean
automaticShippingFee
boolean
headerText
string
footerText
string
customerPaymentTermCode
string
customerContactPersonNo
string Deprecated
customerContact
object (apps-order-service_CustomerContact)
customerContactId
string
name
string
phone
string
email
string
requiredDeposit
number
deductedDeposit
number
remainingDeposit
number
currencyCode
string
targetMarginInPercent
number
priceSourceOrderNo
string
customerCardNumber
string
orderCommands
Array of string
string
Valid values[
"READY_FOR_PACKING",
"PACKING_IN_PROCESS",
"PACKED_AND_READY",
"REST_PROCESSING",
"REST_HOLD",
"PARTIALLY_DELIVERED",
"READY_FOR_TRANSPORT",
"TRANSPORT_IN_PROGRESS",
"UNKNOWN"
]
orderLines
Array of object (apps-order-service_OrderLine)
object
id
string
lineNumber
integer (int32)
oldLineNumber
integer (int32)
lineType
string
Valid values[
"ARTICLE",
"TEXT"
]
articleNo
string
articleText1
string
articleText2
string
unitCode
string
quantity
number
unitPriceExVat
number
unitPriceIncVat
number
costPriceExVat
number
purchasePriceExVat
number
discountPercent1
number
discountPercent2
number
specialDiscountPercent1
number
specialDiscountPercent2
number
campaignCode
string
coveragePercent
number
vatPercent
number
totalCostPriceExVat
number
totalPurchasePriceExVat
number
totalDiscountedPriceExVat
number
totalDiscountedPriceIncVat
number
externalLineStatus
string
quantityDelivered
number
quantityRemaining
number
quantityInvoiced
number
unitPriceOriginalExVat
number
costPriceOriginalExVat
number
warehouseNo
string
departmentNo
string
deliveryTypeCode
string
deliveryTypeName
string
deliveryDate
string (date-time)
priceCode
string
vendorNumber
string
externalArticle
boolean
externalPriceCalculationDescription
string
externalPriceCostCalculationFactor
number
externalPricePurchaseCalculationFactor
number
articleType
string
gtinNo
string
purchaseOrderNumber
string
purchaseOrderLineNumber
integer (int32)
purchaseOrderStatus
string
Valid values[
"PENDING",
"FAILED",
"OK",
"SENT_BY_EMAIL"
]
unitVolumeInQm
number
unitWeightInKg
number
parentLineNumber
integer (int32)
articleOrigin
string
Valid values[
"SOLVE"
]
lineChosen
boolean
warehouseEmployeeText
string
transportEmployeeText
string
transportShipmentReference
string
lockKey
string
lockDetails
object (apps-order-service_LockDetails)
lockedByUser
string
lockedTime
string (date-time)
lockSource
string
source
string
parcels
Array of object (apps-order-service_Parcel)
object
parcelType
string
Valid values[
"TIMBER",
"PALLET",
"OTHER"
]
text
string
printerName
string
readyForPicking
boolean
quote
boolean
nexstepExternalOrderNumber
string
deleted
boolean
draft
boolean
delivered
boolean
aggregate
object (apps-order-service_AggregateResult)
count
integer (int64)
values
Array of object (apps-order-service_SelectResultValue)
object
value
object
stringValue
string
field
string
dataType
string
Valid values[
"INT",
"DATE",
"STRING",
"BIG_DECIMAL"
]
alignment
string
Valid values[
"LEFT",
"CENTER",
"RIGHT"
]
totalAggregate
object (apps-order-service_AggregateResult)
count
integer (int64)
values
Array of object (apps-order-service_SelectResultValue)
object
value
object
stringValue
string
field
string
dataType
string
Valid values[
"INT",
"DATE",
"STRING",
"BIG_DECIMAL"
]
alignment
string
Valid values[
"LEFT",
"CENTER",
"RIGHT"
]
columns
Array of object (apps-order-service_SelectResultColumn)
object
field
string
alignment
string
Valid values[
"LEFT",
"CENTER",
"RIGHT"
]
rows
Array of object (apps-order-service_SelectResultRow)
object
orderId
integer (int64)
locked
boolean
deleteAllowed
boolean
editFollowupDateAllowed
boolean
values
Array of object (apps-order-service_SelectResultValue)
object
value
object
stringValue
string
field
string
dataType
string
Valid values[
"INT",
"DATE",
"STRING",
"BIG_DECIMAL"
]
alignment
string
Valid values[
"LEFT",
"CENTER",
"RIGHT"
]
400
Bad Request
string