SetShipmentRegistration

Registers a sales order with a shipping service provider and can (if supported by the shipping service provider) also directly return a base64 encoded PDF label.

This call is available since SOAP version 105.

SetShipmentRegistration Input

Field Type Occurrence Meaning Available since
AdditionalParams ObjectOptional Additional params 105
AdditionalParams.
PlentySoapObject_Param.
Delemiter
String Optional Delemiter 105
AdditionalParams.
PlentySoapObject_Param.
Entity
ObjectOptional Entity 105
AdditionalParams.
PlentySoapObject_Param.
Entity.
PlentySoapObject_KeyValueParam.
Key
String Optional Key 105
AdditionalParams.
PlentySoapObject_Param.
Entity.
PlentySoapObject_KeyValueParam.
Value
String Optional Value 105
CallItemsLimit Integer Optional Call items limit for own server 112
SearchParams ObjectRequired Search params 105
SearchParams.
PlentySoapObject_Param.
Delemiter
String Optional Delemiter 105
SearchParams.
PlentySoapObject_Param.
Entity
ObjectOptional Entity 105
SearchParams.
PlentySoapObject_Param.
Entity.
PlentySoapObject_KeyValueParam.
Key
String Optional Key 105
SearchParams.
PlentySoapObject_Param.
Entity.
PlentySoapObject_KeyValueParam.
Value
String Optional Value 105
ShippingProvider String Required Shipping provider 105

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

SetShipmentRegistration Output

Field Type Occurrence Meaning Available since
RegisteredOrders ObjectOptional List of registered orders 105
RegisteredOrders.
PlentySoapObject_RegisteredOrder.
OrderID
Integer Optional Sales order ID 105
RegisteredOrders.
PlentySoapObject_RegisteredOrder.
RegisteredPackages
ObjectOptional List of registered packages 105
RegisteredOrders.
PlentySoapObject_RegisteredOrder.
RegisteredPackages.
PlentySoapObject_RegisteredPackage.
PDFContent
ObjectOptional base64 encoded PFD Content 105
RegisteredOrders.
PlentySoapObject_RegisteredOrder.
RegisteredPackages.
PlentySoapObject_RegisteredPackage.
PDFContent.
PlentySoapObject_FileBase64Encoded.
FileData
base64Binary Required base64 encoded document data 105
RegisteredOrders.
PlentySoapObject_RegisteredOrder.
RegisteredPackages.
PlentySoapObject_RegisteredPackage.
PDFContent.
PlentySoapObject_FileBase64Encoded.
FileEnding
String Optional The ending of the file (currently, this is always .pdf for invoice documents) 105
RegisteredOrders.
PlentySoapObject_RegisteredOrder.
RegisteredPackages.
PlentySoapObject_RegisteredPackage.
PDFContent.
PlentySoapObject_FileBase64Encoded.
FileName
String Required The name of the document (should be unique) 105
RegisteredOrders.
PlentySoapObject_RegisteredOrder.
RegisteredPackages.
PlentySoapObject_RegisteredPackage.
PackageId
Integer Optional Package ID 105
RegisteredOrders.
PlentySoapObject_RegisteredOrder.
ShippingDetails
ObjectOptional Shipping detail 105
RegisteredOrders.
PlentySoapObject_RegisteredOrder.
ShippingDetails.
PlentySoapObject_ShippingDetail.
ShippingCosts
Double Optional Shipping costs 105
RegisteredOrders.
PlentySoapObject_RegisteredOrder.
ShippingDetails.
PlentySoapObject_ShippingDetail.
TransactionId
String Optional Transaction 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

SetShipmentRegistration 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 - - - -

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
810 Limit 50 Too many OrderIDs in request The request contains too many OrderIDs for this call. 50 OrderIDs allowed.
800 register shipment failed for order register shipment failed for order
800 SearchParams Missing parameter Required parameter was not entered
800 ShippingProvider 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> </item>
<item>
<Value>Missing parameter</Value>
<Key>SearchParams</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>ShippingProvider</Key>
</item>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben