GetOrdersInvoiceDocumentURLs

The GetOrdersInvoiceDocumentURLs call returns the invoice documents' URLs for a list of sales order IDs.

This call is available since SOAP version 100.
The invoice documents' URLs can be returned for a maximum of 50 sales order IDs per call.
The returned URLs are only valid until midnight of the day that they were retrieved!

GetOrdersInvoiceDocumentURLs Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
GetDocumentAsBinaryData Boolean Optional Returns the documents base64 encoded 105
OrderIDs ObjectRequired List of order IDs 105
OrderIDs.
PlentySoapObject_Integer.
intValue
Integer Optional Integer Value 105

GetOrdersInvoiceDocumentURLs 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_GetOrdersInvoiceDocumentURLs> </PlentySoapRequest_GetOrdersInvoiceDocumentURLs>

GetOrdersInvoiceDocumentURLs Output

Field Type Occurrence Meaning Available since
OrderInvoiceDocumentURL ObjectOptional List of the invoice documents url 105
OrderInvoiceDocumentURL.
PlentySoapObject_GetOrdersInvoiceDocumentURLs.
FileData
base64Binary Optional base64 encoded file data 105
OrderInvoiceDocumentURL.
PlentySoapObject_GetOrdersInvoiceDocumentURLs.
InvoiceDocumentURL
String Optional URL of the invoice document 105
OrderInvoiceDocumentURL.
PlentySoapObject_GetOrdersInvoiceDocumentURLs.
OrderID
Integer Optional Order ID 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

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

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 - - - URL was successfully returned

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
810 Limit 50 Max 50 OrderIDs allowed The maximum number of 50 sales order IDs was exceeded.

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 invoice document available for the given OrderIDs.

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