GetOrdersPaymentInformation

The GetOrdersPaymentInformation call returns payment information for the specified sales orders (OrderIDs).

This call is available since SOAP version 108.

GetOrdersPaymentInformation Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
OrderIDs ObjectRequired List of order IDs 106
OrderIDs.
PlentySoapObject_Integer.
intValue
Integer Optional Integer Value 105

GetOrdersPaymentInformation 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.

<PlentySoapRequest_GetOrdersPaymentInformation> </PlentySoapRequest_GetOrdersPaymentInformation>

GetOrdersPaymentInformation Output

Field Type Occurrence Meaning Available since
OrdersPaymentInformation ObjectOptional List of payment information 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderID
Integer Optional Order ID 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation
ObjectOptional List of payment inforamtion 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
ID
Integer Optional Payment ID 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
OrderID
Integer Optional Order ID 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
PayPalTransactionItemBuyer
String Optional PayPal item buyer 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
PayPalTransactionItemNumber
String Optional PayPal item number 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
PayPalTransactionREFID
String Optional PayPal REFID 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
PayPalTransactionStatus
String Optional Transaction status 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionAmount
Double Optional Amount 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionAssignDate
Integer Optional Assign date 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionCurrency
String Optional Currency 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionCustomerBankAccount
String Optional Customer bank account 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionCustomerBankCode
String Optional Customer bank code 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionCustomerEmail
String Optional Customer e-mail address 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionCustomerFirstname
String Optional Customer firstname 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionCustomerId
String Optional Customer ID 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionCustomerLastname
String Optional Customer lastname 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionExcangeRatio
Double Optional Excange ratio 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionID
String Optional Transaction ID 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionImportDate
Integer Optional Import date 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionReceiverName
String Optional Receiver name 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionText
String Optional Text 106
OrdersPaymentInformation.
PlentySoapObject_GetOrdersPaymentInformation.
OrderPaymentInformation.
PlentySoapObject_OrdersPaymentInformation.
TransactionType
String Optional Type 106
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

GetOrdersPaymentInformation 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_GetOrdersPaymentInformation>
<Success>Boolean</Success>
</PlentySoapResponse_GetOrdersPaymentInformation>

Identification Keys

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

Key Value
OrderID dynamicValue

Identification Output schema

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

Success messages

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

Code Key Value Message Explanation
100 - - - Data was received for this order

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
810 Limit 100 Max 50 orders allowed A maximum of 50 sales order IDs can be edited per call.

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.

Warnings

Code Key Value Message Explanation
110 No data No data found No Payment information for this order found.

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.

Nach oben