/apps-order-service/api/orders/search

Prev Next
Post
/apps-order-service/api/orders/search
Body parameters
Expand All
object
orderFlowIndicators
Array of string
string
Valid values[ "DRAFT", "QUOTE", "COMMITED", "DELIVERED" ]
externalOrderStatuses
Array of string
string
searchType
string
Valid values[ "NORMAL", "FOR_PREPAYMENT" ]
orderNumber
integer (int64)
orderNumbers
Array of integer
integer (int64)
externalSystemCode
string
externalOrderId
string
externalOrderReferences
Array of object (apps-order-service_ExternalOrderReferenceSearchCriteria)
object
externalSystemCode
string
externalOrderNo
string
customerNo
string
projectNo
string
freeSearchText
string
includeDeletedOrders
boolean
offset
integer (int32)
limit
integer (int32)
orderBy
string
Valid values[ "DEFAULT", "ORDERDATE_ASC", "ORDERDATE_DESC", "ORDERNUMBER_ASC", "ORDERNUMBER_DESC", "ORDERPROJECT_ASC", "ORDERPROJECT_DESC", "DELIVERYDATE_ASC", "DELIVERYDATE_DESC", "EXTERNAL_ORDER_ID_ASC", "EXTERNAL_ORDER_ID_DESC" ]
Responses
200

OK

Expand All
object
offset
integer (int32)
limit
integer (int32)
orders
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
400

Bad Request

string