AddDocument

The AddOrderDocument call adds documents to an order.

This call is available since SOAP version 111.
It is possible to use the following document type values: Invoice, InvoiceExternal, MultiInvoice, DeliveryNote, CreditNote, CorrectionDocument, MultiCreditNote, OrderConfirmation, Offer, Reorder, DunningLetter, RepairBill, PickUpDelivery, ReturnNote, SuccessConfirmation, Category

To add an category image you have to use ContentPage as document type. Also you have to enter a category ID as reference.

AddDocument Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
DocumentList ObjectOptional Order document list 112
DocumentList.
PlentySoapRequestObject_AddDocument.
CategoryID
Integer Optional Category ID 112
DocumentList.
PlentySoapRequestObject_AddDocument.
Document
ObjectRequired base64 encoded document data 112
DocumentList.
PlentySoapRequestObject_AddDocument.
Document.
PlentySoapObject_FileBase64Encoded.
FileData
base64Binary Required base64 encoded document data 105
DocumentList.
PlentySoapRequestObject_AddDocument.
Document.
PlentySoapObject_FileBase64Encoded.
FileEnding
String Optional The ending of the file (currently, this is always .pdf for invoice documents) 105
DocumentList.
PlentySoapRequestObject_AddDocument.
Document.
PlentySoapObject_FileBase64Encoded.
FileName
String Required The name of the document (should be unique) 105
DocumentList.
PlentySoapRequestObject_AddDocument.
DocumentCreated
Integer Optional Document created 112
DocumentList.
PlentySoapRequestObject_AddDocument.
IdentificationValue
String Optional IdentificationValue 112
DocumentList.
PlentySoapRequestObject_AddDocument.
OrderDocumentType
ObjectOptional Order document type 112
DocumentList.
PlentySoapRequestObject_AddDocument.
OrderID
Integer Optional Order ID 112

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

AddDocument Output

Field Type Occurrence Meaning Available since
Documents ObjectOptional Documents 112
Documents.
PlentySoapResponseObject_AddDocument.
IdentificationValue
String Optional IdentificationValue 112
OrderID Integer Optional Order ID 112
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

AddDocument 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 - - - Documents were successfully added

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 DocumentType Missing parameter Required parameter was not entered
800 DocumentType Invalid parameter The value of entered parameter is not allowed
800 FileName FileName already exists Document could not be saved. A document with this file name already exists!
800 FileData Invalid parameter The value of entered parameter is not allowed

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>DocumentType</Key>
</item>
<item>
<Value>Invalid parameter</Value>
<Key>DocumentType</Key>
</item>
<item>
<Value>Invalid parameter</Value>
<Key>FileData</Key>
</item>
</ErrorMessages>

Warnings

Code Key Value Message Explanation
110 No data No data found Could not find order for the given order ID. Order documents could not be uploaded.

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