SearchOrders

The SearchOrders call returns a list of sales orders according to the search parameters you set. If order delivery address is a packstation, then you can find the packstation data in the field "street".The schema ist "PACKSTATION;Postident;HouseNumber". The corresponding stock units are also returned along with the sales orders. Use the parameter GetSalesOrderProperties if you want to receive the item properties as well.

Use the parameters GetOrderCustomerAddress and GetOrderDeliveryAddress if you also need the invoice address and/or the delivery address.

Use the parameter GetOrderInfo to receive the additional information.

This call is available since SOAP version 100.
Up to 25 sales orders can be returned.
The following parameters can be used to Output different data: GetIncomingPayments=true => Outputs incoming payments; GetOrderCustomerAddress=true => Outputs the customer address of an order; GetOrderDeliveryAddress=true => Outputs the delivery address of an order; GetOrderDocumentNumbers=true => Outputs invoice number of an order; GetOrderInfo=true => Outputs information about an order; GetParcelService=true => Outputs parcel service information; GetSalesOrderProperties=true => Outputs sales order properties. You can use the parameter Page to specify which page you want to retrieve. In the response object, the value Pages indicates how many pages can be retrieved in total. If you want to retrieve the first page, then you have to use the value 0 as the Page parameter (this is the default numbering scheme for retrieving pages). The last page has the value Pages minus 1.

SearchOrders Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
CustomerCountryID Integer Optional The customers country ID 105
DeliveryAddressCountryID Integer Optional The country ID of the delivery address 105
ExternalOrderID String Required External Order ID 107
GetIncomingPayments Boolean Optional Returns the incomming payments 109
GetOrderCustomerAddress Boolean Optional Returns the customer address 105
GetOrderDeliveryAddress Boolean Optional Returns the delivery address 105
GetOrderDocumentNumbers Boolean Optional Returns the corresponding order document numbers 107
GetOrderInfo Boolean Optional Returns the order info 105
GetParcelService Boolean Optional Returns the parcel service 105
GetPaymentInformation Boolean Optional Returns the payment information 111
GetSalesOrderProperties Boolean Optional Returns the sales order properties 106
InvoiceNumber String Optional Invoice number 105
LastUpdateFrom Integer Required Last edit from 105
LastUpdateTill Integer Required Last edit until 105
OrderCompletedFrom Integer Optional Date (timestamp) the sales order was completed (from) 105
OrderCompletedTill Integer Optional Date (timestamp) the sales order was completed (until) 105
OrderCreatedFrom Integer Optional Date (timestamp) sales order was created (from) 105
OrderCreatedTill Integer Optional Date (timestamp) sales order was created (until) 105
OrderID Integer Required Order ID 105
OrderPaidFrom Integer Optional Date (timestamp) sales order was paid for (from) 105
OrderPaidTill Integer Optional Date (timestamp) sales order was paid for (until) 105
OrderStatus Double Required Sales order status 105
OrderStatusFrom Double Required Sales order status 108
OrderStatusTo Double Required Sales order status 108
OrderType String Required Sales order type 105
OrderWarehouseID Integer Optional Order warehouse ID 108
Page Integer Optional Page 105
ReferrerID Integer Optional Sales order referrer 105
StoreID Integer Required Multishop ID 110

SearchOrders Input schema

The box below lists all fields that could be included in the call request (version 112). To learn more about an individual field or its type, click its name in the box.

SearchOrders Output

Field Type Occurrence Meaning Available since
Orders ObjectOptional List of orders 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress
ObjectOptional Customer address 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
AdditionalName
String Optional Additional name 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
City
String Optional City 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
Company
String Optional Company 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
CountryID
Integer Optional Country ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
CountryISO2
String Optional Country ISO2 107
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
CustomerID
Integer Optional Customer ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
CustomerNo
String Optional Customer Number 110
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
EbayName
String Optional eBay Name 107
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
Email
String Optional E-mail address 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
ExternalCustomerNo
String Optional External Customer Number 110
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
Fax
String Optional Fax 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
FirstName
String Optional Firstname 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
FormOfAddress
Integer Optional Form of address 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
HouseNumber
String Optional House number 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
Postident
String Optional Postident 110
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
Street
String Optional Street 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
Surname
String Optional Lastname 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
Telephone
String Optional Telephone number 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
Title
String Optional Title 105
Orders.
PlentySoapObject_SearchOrders.
OrderCustomerAddress.
PlentySoapObject_CustomerAddress.
ZIP
String Optional ZIP 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress
ObjectOptional Delivery address 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
AdditionalName
String Optional Additional name 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
City
String Optional City 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
Company
String Optional Company 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
CountryID
Integer Optional Country ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
CountryISO2
String Optional Country code 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
CustomerID
Integer Optional Customer ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
DeliveryAddressID
Integer Optional Delivery address ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
Email
String Optional E-mail address 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
Evaluation
String Optional Evaluation 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
ExternalDeliveryAddressID
String Optional External delivery address ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
Fax
String Optional Fax number 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
FirstName
String Optional First name 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
FormOfAddress
Integer Optional Form of address 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
HouseNumber
String Optional House number 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
Postident
String Optional Postident 110
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
Street
String Optional Street 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
Surname
String Optional Surname 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
Telephone
String Optional Telephone number 105
Orders.
PlentySoapObject_SearchOrders.
OrderDeliveryAddress.
PlentySoapObject_DeliveryAddress.
ZIP
String Optional ZIP code 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead
ObjectOptional Sales order data 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
Currency
String Optional Currency 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
CustomerID
Integer Required Customer ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
CustomerReference
String Optional Customer Reference 110
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
DeliveryAddressID
Integer Optional Delivery address ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
DoneTimestamp
String Optional Order completion timestamp 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
DunningLevel
Integer Optional Dunning level 106
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
EbaySellerAccount
String Optional EbaySellerAccount 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
EstimatedTimeOfShipment
String Optional $Estimated time of shipment 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
ExchangeRatio
Double Optional Exchange ratio 106
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
ExternalOrderID
String Required External sales order ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
IncomingPayments
ObjectOptional Incoming payments 109
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
IncomingPayments.
PlentySoapObject_OrderIncomingPayment.
ID
Integer Optional ID 109
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
IncomingPayments.
PlentySoapObject_OrderIncomingPayment.
ReferenceID
String Optional Reference ID 109
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
Invoice
String Optional Invoice number 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
IsNetto
Boolean Optional Is netto? 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
LastUpdate
Integer Optional Last update 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
Marking1ID
Integer Optional ID of marking 1 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
MethodOfPaymentID
Integer Optional Payment method ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers
ObjectOptional All corresponding document numbers 107
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
CreditNoteNumber
String Optional credit note number 107
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
DeliveryNoteNumber
ObjectOptional delivery note number 107
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
DeliveryNoteNumber.
PlentySoapObject_String.
Value
String Optional String Value 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
DunningLetterNumber
ObjectOptional dunning letter number 107
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
DunningLetterNumber.
PlentySoapObject_String.
Value
String Optional String Value 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
InvoiceNumber
String Optional invoice number 107
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
OfferNumber
String Optional offer number 107
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
OrderConfirmationNumber
String Optional order confirmation number 107
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
PickupDeliveryNumber
String Optional pickup delivery number 107
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
RepairBillNumber
String Optional repair bill number 107
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
ReturnNoteNumber
String Optional return note number 107
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderDocumentNumbers.
PlentySoapObject_OrderDocumentNumbers.
SuccessConfirmationNumber
String Optional success confirmation number 107
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderID
Integer Optional Sales order ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderInfos
ObjectOptional Order infos 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderInfos.
PlentySoapObject_OrderInfo.
Info
String Optional Tab: Info (in the sales order) 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderInfos.
PlentySoapObject_OrderInfo.
InfoCustomer
Integer Optional 1 = Information is from the sales order customer 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderInfos.
PlentySoapObject_OrderInfo.
InfoDate
Integer Optional Date 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderInfos.
PlentySoapObject_OrderInfo.
InfoID
Integer Optional Info-ID 106
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderInfos.
PlentySoapObject_OrderInfo.
InfoUser
Integer Optional User ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderStatus
Double Optional Sales order status 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderTimestamp
Integer Optional The time of the sales order - timestamp 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
OrderType
String Optional Sales order type 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
PackageNumber
String Optional Package number 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
PaidTimestamp
String Optional Incoming payment timestamp 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
ParentOrderID
Integer Optional Parent sales order ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
PaymentStatus
Integer Optional Payment status 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
ReferrerID
Integer Optional Sales order referrer ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
RemoteIP
String Optional IP 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
ResponsibleID
Integer Optional ID of the person responsible 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
SalesAgentID
Integer Optional SalesAgentID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
SellerAccount
String Optional SellerAccount 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
ShippingCosts
Double Optional Shipping costs 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
ShippingID
Integer Optional Shipping ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
ShippingMethodID
Integer Optional Shipping service provider ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
ShippingProfileID
Integer Optional Shipping profile ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
StoreID
Integer Optional Multishop ID 110
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
TotalBrutto
Double Optional Gross 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
TotalInvoice
Double Optional Total invoice 106
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
TotalNetto
Double Optional Net 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
TotalVAT
Double Optional Total VAT 105
Orders.
PlentySoapObject_SearchOrders.
OrderHead.
PlentySoapObject_OrderHead.
WarehouseID
Integer Optional Warehouse ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems
ObjectOptional List of order items 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
BundleItemID
Integer Optional Bundle item ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
Currency
String Optional Currency 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
EAN
String Optional EAN 111
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
EAN2
String Optional EAN 2 111
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
EAN3
String Optional EAN 3 111
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
EAN4
String Optional EAN 4 111
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
ExternalItemID
String Optional external item id 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
ExternalOrderItemID
String Optional External item ID 106
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
ItemID
Integer Optional Item ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
ItemNo
String Optional Item no 106
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
ItemRebate
Double Optional Item rebate (percentaged) 108
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
ItemText
String Optional Item text 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
NeckermannItemNo
String Optional Neckermann item no 106
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
OrderID
Integer Required Order ID 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
OrderRowID
Integer Optional Order row id 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
ParentOrderRowID
Integer Optional Parent order row id 110
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
Price
Double Optional Price 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
Quantity
Double Optional Quantity 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
ReferrerID
Integer Optional Referrer 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
RowType
ObjectOptional Item row type 111
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
SKU
String Optional The item's SKU 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
SalesOrderProperties
ObjectOptional Sales order Properties 106
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
SalesOrderProperties.
PlentySoapObject_SalesOrderProperty.
SalesOrderPropertyID
Integer Optional Sales order property id 106
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
SalesOrderProperties.
PlentySoapObject_SalesOrderProperty.
SalesOrderPropertyName
String Optional Sales order property name 106
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
SalesOrderProperties.
PlentySoapObject_SalesOrderProperty.
SalesOrderPropertyType
String Optional Sales order property type 106
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
SalesOrderProperties.
PlentySoapObject_SalesOrderProperty.
SalesOrderPropertyValue
String Optional Sales order property value 106
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
VAT
Double Optional VAT 105
Orders.
PlentySoapObject_SearchOrders.
OrderItems.
PlentySoapObject_OrderItem.
WarehouseID
Integer Optional Warehouse ID 105
Orders.
PlentySoapObject_SearchOrders.
PaymentInformationList
ObjectOptional Payment information list 111
Orders.
PlentySoapObject_SearchOrders.
PaymentInformationList.
PlentySoapObject_PaymentInformation.
MethodOfPaymentId
Integer Optional Method of payment Id 111
Orders.
PlentySoapObject_SearchOrders.
PaymentInformationList.
PlentySoapObject_PaymentInformation.
MethodOfPaymentName
String Optional Method of payment name 111
Orders.
PlentySoapObject_SearchOrders.
PaymentInformationList.
PlentySoapObject_PaymentInformation.
PaymentReferenceList
ObjectOptional Payment reference 111
Orders.
PlentySoapObject_SearchOrders.
PaymentInformationList.
PlentySoapObject_PaymentInformation.
PaymentReferenceList.
PlentySoapObject_String.
Value
String Optional String Value 105
Orders.
PlentySoapObject_SearchOrders.
PaymentInformationList.
PlentySoapObject_PaymentInformation.
TransactionAmount
Double Optional Transaction amount 111
Orders.
PlentySoapObject_SearchOrders.
PaymentInformationList.
PlentySoapObject_PaymentInformation.
TransactionAssignDate
Integer Optional Transaction assign date 111
Orders.
PlentySoapObject_SearchOrders.
PaymentInformationList.
PlentySoapObject_PaymentInformation.
TransactionCurrency
String Optional Transaction currency 111
Orders.
PlentySoapObject_SearchOrders.
PaymentInformationList.
PlentySoapObject_PaymentInformation.
TransactionId
String Optional Transaction Id 111
Pages Integer Optional Pages 105
ResponseMessages ObjectOptional Returns a list of error messages for the current call. 112
ResponseMessages.
PlentySoapResponseMessage.
Code
Integer Optional Code 105
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
IdentificationKey
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
IdentificationValue
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
Success Boolean Optional Has the value true or false, depending on whether a request worked. 112

SearchOrders Output schema

The box below lists all fields that could be included in the response call (version 112). To learn more about an individual field or its type, click its name in the box.

<PlentySoapResponse_SearchOrders>
<Orders>
<PlentySoapObject_SearchOrders>
<OrderHead>
<PlentySoapObject_OrderHead>
<Currency>String</Currency>
<Invoice>String</Invoice>
<IsNetto>Boolean</IsNetto>
<OrderID>Integer</OrderID>
<RemoteIP>String</RemoteIP>
<StoreID>Integer</StoreID>
<TotalVAT>Double</TotalVAT>
</PlentySoapObject_OrderHead>
</OrderHead>
</PlentySoapObject_SearchOrders>
</Orders>
<Pages>Integer</Pages>
<Success>Boolean</Success>
</PlentySoapResponse_SearchOrders>

Identification Keys

For this call no identification keys and values exist.

Identification Output schema

For this call no identification output schema exists.

Success messages

(The dynamicValue stands for any parameter values that could be outputted.)

Code Key Value Message Explanation
100 - - - Sales order was successfully returned

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 OrderType Missing parameter Required parameter was not entered
800 OrderStatus Missing parameter Required parameter was not entered
800 OrderStatusFrom Missing parameter Required parameter was not entered
800 OrderStatusTo Missing parameter Required parameter was not entered
800 StoreID Missing parameter Required parameter was not entered
800 OrderID Missing parameter Required parameter was not entered
800 ExternalOrderID Missing parameter Required parameter was not entered
800 LastUpdateFrom Missing parameter Required parameter was not entered

Error messages Output schema

The box below lists all error message fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

<ErrorMessages>
<item>
<Value>Missing parameter</Value>
<Key>OrderType</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>OrderStatus</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>OrderStatusFrom</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>OrderStatusTo</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>StoreID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>OrderID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>ExternalOrderID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>LastUpdateFrom</Key>
</item>
</ErrorMessages>

Warnings

Code Key Value Message Explanation
110 Page Unused parameter Parameter was not entered. A default value was used for the call.

Warnings Output schema

The box below lists all warning fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

<Warnings>
<item>
<Value>Unused parameter</Value>
</item>
</Warnings>
Nach oben