GetOrderDocument

The GetOrderDocument call returns the documents for an order ID and a defined document type.

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

GetOrderDocument Input

Field Type Occurrence Meaning Available since
OrderDocumentType ObjectOptional Order document type 111
OrderID Integer Optional Order ID 111

GetOrderDocument 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_GetOrderDocument>
<OrderID>Integer</OrderID>
</PlentySoapRequest_GetOrderDocument>

GetOrderDocument Output

Field Type Occurrence Meaning Available since
OrderDocumentList ObjectOptional Order document list 111
OrderDocumentList.
PlentySoapObject_GetOrderDocument.
DocumentCreated
Integer Optional Document created 111
OrderDocumentList.
PlentySoapObject_GetOrderDocument.
DocumentDisplayDate
Integer Optional Document display date 111
OrderDocumentList.
PlentySoapObject_GetOrderDocument.
DocumentID
Integer Optional Document ID 111
OrderDocumentList.
PlentySoapObject_GetOrderDocument.
DocumentNumber
String Optional Document number 111
OrderDocumentList.
PlentySoapObject_GetOrderDocument.
DocumentType
String Optional Document type 111
OrderDocumentList.
PlentySoapObject_GetOrderDocument.
DocumentUpdated
Integer Optional Document updated 111
OrderDocumentList.
PlentySoapObject_GetOrderDocument.
DocumentUserID
Integer Optional Document user ID 111
OrderDocumentList.
PlentySoapObject_GetOrderDocument.
base64Data
ObjectOptional Order document base64 data 111
OrderDocumentList.
PlentySoapObject_GetOrderDocument.
base64Data.
PlentySoapObject_FileBase64Encoded.
FileData
base64Binary Required base64 encoded document data 105
OrderDocumentList.
PlentySoapObject_GetOrderDocument.
base64Data.
PlentySoapObject_FileBase64Encoded.
FileEnding
String Optional The ending of the file (currently, this is always .pdf for invoice documents) 105
OrderDocumentList.
PlentySoapObject_GetOrderDocument.
base64Data.
PlentySoapObject_FileBase64Encoded.
FileName
String Required The name of the document (should be unique) 105
OrderID Integer Optional Order ID 111
ResponseMessages not definedOptional 112
Success not definedOptional 112

GetOrderDocument 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 returned

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 OrderID Missing parameter Required parameter was not entered
800 OrderID 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>OrderID</Key>
</item>
<item>
<Value>Invalid parameter</Value>
<Key>OrderID</Key>
</item>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben