Web Service: OnlineMbe

Port type OnlineMbeSource code

1. AddAttachmentRequest
   Source code
   Description:
   This operation allows the attachment of files relating them to an existing shipment. Only one shipment can be referenced on each request, but more than one file can be attached to it.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://www.onlinembe.de/ws/AddAttachmentRequest
   Input:
   AddAttachmentRequestRequest (soap:body, use = literal)Source code
   parameters type AddAttachmentRequest

   • RequestContainer type AddAttachmentRequestType
     • Credentials type CredentialsType
       The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
       • Username - type string with restriction maxLength(25)
         Client/admin username as used in OnlineMbe web interface.
       • Passphrase - type string with restriction maxLength(32)
         Passphrase for username. Must be given by the franchise administrator.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • MasterTrackingMBE type string
       MBE Master Tracking of the shipment to attach the files.
     • Attachment type AttachmentType
       • AttachmentName type string
         This field indicates the name of the attached file (without path).
       • AttachmentData type base64Binary
         In this field the attached file is encoded as base64 binary data.
   Output:
   AddAttachmentRequestResponse (soap:body, use = literal)Source code
   parameters type AddAttachmentRequestResponse

   • RequestContainer type AddAttachmentResponseType
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • Status type StatusType
       This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
       - type token with restriction - enumeration
       • OK - The response indicates that the requested operation has been done without problems.
       • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
     • Errors - optional; type ErrorsType
       A list of the different errors that generated the ERROR status will be included here.
       • Error - unbounded; type ErrorType
         • Id type int
           A number that identifies this error. This number is guaranteed to be unique within a request context.
         • Description type string
           A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
     • TotalAttachedFiles - optional; type int
2. CloseShipmentsRequest
   Source code
   Description:
   This operation allows the client to close the indicated shipments in the parameter MasterTrackingsMBE that accepts one MBE master tracking code and can be repeated as much times as needed.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://www.onlinembe.de/ws/CloseShipmentsRequest
   Input:
   CloseShipmentsRequestRequest (soap:body, use = literal)Source code
   parameters type CloseShipmentsRequest

   • RequestContainer type CloseShipmentsRequestType
     • SystemType type SystemType
       Important notice: This parameter is maintained for compatibility. It was created in previous version of this webservice but now it's completely useless. The system is defined by the calling url (www.onlinembe.de, new.onlinembe.es, etc), and one system can not return information from another instance.
       - type token with restriction - enumeration
       • IT
       • DE
       • ES
       • AT
       • FR
     • Credentials type CredentialsType
       The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
       • Username - type string with restriction maxLength(25)
         Client/admin username as used in OnlineMbe web interface.
       • Passphrase - type string with restriction maxLength(32)
         Passphrase for username. Must be given by the franchise administrator.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • MasterTrackingsMBE - unbounded; - type string with restriction maxLength(20)
       MBE master tracking for one shipment that needs to be closed (Ex: MBE-8888-1-00000103). This parameter can be repeated as many times as needed, one for each shipment to be closed.
   Output:
   CloseShipmentsRequestResponse (soap:body, use = literal)Source code
   parameters type CloseShipmentsRequestResponse

   • RequestContainer type CloseShipmentsResponseType
     • Status type StatusType
       This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
       - type token with restriction - enumeration
       • OK - The response indicates that the requested operation has been done without problems.
       • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
     • Errors - optional; type ErrorsType
       A list of the different errors that generated the ERROR status will be included here.
       • Error - unbounded; type ErrorType
         • Id type int
           A number that identifies this error. This number is guaranteed to be unique within a request context.
         • Description type string
           A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
     • ShipmentClosed - optional; type int
       Number that identifies the closing of the different shipments indicated in this request.
     • TotalPackages - optional; type int
       This is the sum of all the packages on all shipments closed.
     • Pdf - optional; type base64Binary
       PDF report for the shipment closing procedure. It's encoded in base64 format, must be decoded and saved as a PDF file for its use.
3. CustomersListRequest
   Source code
   Description:
   Using this operation an admin can get the full customers list for a given store id.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://www.onlinembe.de/ws/CustomersListRequest
   Input:
   CustomersListRequestRequest (soap:body, use = literal)Source code
   parameters type CustomersListRequest

   • RequestContainer type CustomersListRequestType
     • Credentials type CredentialsType
       The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
       • Username - type string with restriction maxLength(25)
         Client/admin username as used in OnlineMbe web interface.
       • Passphrase - type string with restriction maxLength(32)
         Passphrase for username. Must be given by the franchise administrator.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • StoreID - type string with restriction length(4)
     • notMigrated - optional; type boolean
   Output:
   CustomersListRequestResponse (soap:body, use = literal)Source code
   parameters type CustomersListRequestResponse

   • RequestContainer type CustomersListResponseType
     • Status type StatusType
       This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
       - type token with restriction - enumeration
       • OK - The response indicates that the requested operation has been done without problems.
       • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
     • Errors - optional; type ErrorsType
       A list of the different errors that generated the ERROR status will be included here.
       • Error - unbounded; type ErrorType
         • Id type int
           A number that identifies this error. This number is guaranteed to be unique within a request context.
         • Description type string
           A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • Cutomers - optional; type Customers
       • Customer - optional, unbounded; type CustomerType
         • customerID - optional; type int
         • StoreID - optional; - type string with restriction length(4)
         • SamID - optional; - type string with restriction maxLength(11)
         • DepartmentID - optional; type int
         • Login - type string with restriction maxLength(25)
         • Password - optional; - type string with restriction maxLength(25)
         • CompanyName - optional; - type string with restriction maxLength(75)
         • CustomerName - optional; - type string with restriction maxLength(75)
         • VATNumber - optional; - type string with restriction maxLength(11)
         • Address - optional; - type string with restriction maxLength(100)
         • ZIPCode - optional; - type string with restriction maxLength(10)
         • City - optional; - type string with restriction maxLength(50)
         • State - optional; - type string with restriction length(2)
         • Country - optional; - type string with restriction maxLength(2)
         • Phone - optional; - type string with restriction maxLength(50)
         • Fax - optional; - type string with restriction maxLength(50)
         • Mobile - optional; - type string with restriction maxLength(50)
         • Email - optional; - type string with restriction maxLength(75)
         • Enabled - optional; type boolean
         • Permissions - optional; type Permissions
           • canSeeTracking - optional; type string
           • canSpecifyCOD - optional; type boolean
           • maxCODvalue - optional; type decimal
           • canSpecifyInsurance - optional; type boolean
           • maxInsuranceValue - optional; type decimal
           • canCreateCourierWaybill - optional; type boolean
           • canSpecifyCustomToSender - optional; type boolean
           • canSpecifySaturdayDelivery - optional; type boolean
           • canChooseMBEService - optional; type boolean
           • canChooseCourier - optional; type boolean
           • canChooseCourierService - optional; type boolean
           • canRequestImport - optional; type boolean
           • canChooseMBEShipType - optional; type boolean
           • canViewInvoices - optional; type boolean
           • canViewLoyalty - optional; type boolean
           • canUploadfiles - optional; type boolean
           • canDeleteShipments - optional; type boolean
           • enabledCouriers - optional; type string
           • enabledCourierServices - optional; type string
           • enabledCourierServicesDesc - optional; type string
           • canViewPricelist - optional; type boolean
           • maxShipmentWeight - optional; type decimal
           • maxParcelWeight - optional; type decimal
           • enabledServices - optional; type string
           • enabledServicesDesc - optional; type string
           • canSpecifyMBESafeValue - optional; type boolean
           • maxMBESafeValueValue - optional; type decimal
           • canReceiveNotificationsDeparture - optional; type boolean
           • canReceiveNotificationsDelivery - optional; type boolean
           • canReceiveNotificationsException - optional; type boolean
           • notificationEmail1 - optional; type string
           • notificationEmail2 - optional; type string
           • notificationEmail3 - optional; type string
           • notificationEmail4 - optional; type string
           • canPrintProforma - optional; type boolean
           • printInternalReferenceOnWaybill - optional; type boolean
           • hasAcceptedPrivacyAgreement - optional; type boolean
           • hasAcceptedTermsConditions - optional; type boolean
           • latestPickupTime - optional; type string
           • customsDutyToSenderUPSCode - optional; type string
           • customsDutyToSenderUPSZip - optional; type string
           • customsDutyToSenderFEDCode - optional; type string
           • customsDutyToSenderDHLCode - optional; type string
           • useCustomerAddressAsSender - optional; type boolean
           • useDepartmentAddressAsSender - optional; type boolean
           • canPrintManifest - optional; type boolean
           • isThermalLabel - optional; type boolean
           • isThermalLabelUPS - optional; type boolean
           • isThermalLabelFED - optional; type boolean
           • isThermalLabelSDA - optional; type boolean
           • isThermalLabelNEX - optional; type boolean
           • isThermalLabelCHX - optional; type boolean
           • isThermalLabelDHL - optional; type boolean
           • isThermalLabelDPD - optional; type boolean
           • isThermalLabelPOS - optional; type boolean
           • isThermalLabelSGT - optional; type boolean
           • isThermalLabelTNT - optional; type boolean
           • minShipmentWeight - optional; type decimal
           • minParcelWeight - optional; type decimal
           • defaultCODType - optional; - type token with restriction - enumeration
             • CASH
             • CHECK
           • canRequestReturn - optional; type boolean
           • canCreateCourierWaybillReturn - optional; type boolean
           • canSpecifyReturnOptionUPSPrintLabel - optional; type boolean
           • canSpecifyReturnOptionUPS1Attempt - optional; type boolean
           • canSpecifyReturnOptionUPS3Attempts - optional; type boolean
           • canSpecifyReturnOptionUPSElectronicLabel - optional; type boolean
           • canSpecifyReturnRecipientOptionCustomer - optional; type boolean
           • canSpecifyReturnRecipientOptionStore - optional; type boolean
           • canSpecifyReturnRecipientOptionDepartment - optional; type boolean
           • canSeeDetailedSurchargePrices - optional; type boolean
           • canSeeEstimatedDeliveryDates - optional; type boolean
           • warningOnPickups - optional; type string
           • isDimensionMandatory - optional; type boolean
           • isDisabledMultipleShipment - optional; type boolean
           • canUseDPDPredict - optional; type boolean
           • isChoosingDepartmentMandatory - optional; type boolean
           • closesShipmentsAutomatically - optional; type boolean
           • shipmentClosureTime - optional; type string
           • isUPSSignatureRequired - optional; type boolean
           • canSendEmailProductsOnClosure - optional; type boolean
           • canSelectShipmentValueCurrency - optional; type boolean
           • forceNotPrintInstrDocsTNT - optional; type boolean
           • addInternalNotesToMBEWaybill - optional; type boolean
           • canSaveAndShowPrice - optional; type boolean
           • showPriceOnMBEWaybill - optional; type boolean
           • canUploadShipments - optional; type boolean
           • attachProductExportToEmail - optional; type boolean
           • showSaveDefaultShipmentValues - optional; type boolean
           • sendUPSNotificationsToApiShipments - optional; type boolean
           • sendUPSDepartureNotificationsToApiShipments - optional; type boolean
           • sendUPSArrivalNotificationsToApiShipments - optional; type boolean
           • sendUPSExceptionNotificationsToApiShipments - optional; type boolean
           • sendDPDPredictNotificationsToApiShipments - optional; type boolean
           • sendDPDPredictNotificationChannelToApiShipments - optional; - type token with restriction - enumeration
             • EMAIL
             • SMS
           • enabledShipUAP - optional; type boolean
4. DeleteShipmentsRequest
   Source code
   Description:
   With DeleteShipmentsRequest is possible to delete one or more shipments indicating its MBE master tracking codes in the MasterTrackingsMBE, repeated as many times as needed.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://www.onlinembe.de/ws/DeleteShipmentsRequest
   Input:
   DeleteShipmentsRequestRequest (soap:body, use = literal)Source code
   parameters type DeleteShipmentsRequest

   • RequestContainer type DeleteShipmentsRequestType
     • SystemType type SystemType
       Important notice: This parameter is maintained for compatibility. It was created in previous version of this webservice but now it's completely useless. The system is defined by the calling url (www.onlinembe.de, new.onlinembe.es, etc), and one system can not return information from another instance.
       - type token with restriction - enumeration
       • IT
       • DE
       • ES
       • AT
       • FR
     • Credentials type CredentialsType
       The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
       • Username - type string with restriction maxLength(25)
         Client/admin username as used in OnlineMbe web interface.
       • Passphrase - type string with restriction maxLength(32)
         Passphrase for username. Must be given by the franchise administrator.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • MasterTrackingsMBE - unbounded; - type string with restriction maxLength(20)
       MBE master tracking for one shipment that needs to be deleted (Ex: MBE-8888-1-00000103). This parameter can be repeated as many times as needed, one for each shipment to be deleted.
   Output:
   DeleteShipmentsRequestResponse (soap:body, use = literal)Source code
   parameters type DeleteShipmentsRequestResponse

   • RequestContainer type DeleteShipmentsResponseType
     • Status type StatusType
       This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
       - type token with restriction - enumeration
       • OK - The response indicates that the requested operation has been done without problems.
       • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
     • Errors - optional; type ErrorsType
       A list of the different errors that generated the ERROR status will be included here.
       • Error - unbounded; type ErrorType
         • Id type int
           A number that identifies this error. This number is guaranteed to be unique within a request context.
         • Description type string
           A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
     • ShipmentDeleted - optional; type int
     • TotalPackages - optional; type int
5. ListDepartmentsRequest
   Source code
   Description:
   ListDepartmentsRequest returns a list of departments defined for a given customer.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://www.onlinembe.de/ws/ListDepartmentsRequest
   Input:
   ListDepartmentsRequestRequest (soap:body, use = literal)Source code
   parameters type ListDepartmentsRequest

   • RequestContainer type ListDepartmentsRequestType
     • Credentials type CredentialsType
       The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
       • Username - type string with restriction maxLength(25)
         Client/admin username as used in OnlineMbe web interface.
       • Passphrase - type string with restriction maxLength(32)
         Passphrase for username. Must be given by the franchise administrator.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • CustomerID type int
     • OnlyWithEmptyAddress - optional; type boolean
   Output:
   ListDepartmentsRequestResponse (soap:body, use = literal)Source code
   parameters type ListDepartmentsRequestResponse

   • RequestContainer type ListDepartmentsResponseType
     • Status type StatusType
       This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
       - type token with restriction - enumeration
       • OK - The response indicates that the requested operation has been done without problems.
       • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
     • Errors - optional; type ErrorsType
       A list of the different errors that generated the ERROR status will be included here.
       • Error - unbounded; type ErrorType
         • Id type int
           A number that identifies this error. This number is guaranteed to be unique within a request context.
         • Description type string
           A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • Department - unbounded; type ListedDepartmentType
       • ID type int
       • Name type string
       • SamID type string
       • ContactName - optional, nillable; type string
       • Address - optional, nillable; type string
       • Address2 - optional, nillable; type string
       • Address3 - optional, nillable; type string
       • ZipCode - optional, nillable; type string
       • City - optional, nillable; type string
       • State - optional, nillable; type string
       • SubzoneId - optional, nillable; type int
       • Country - optional, nillable; type string
       • Phone - optional, nillable; type string
       • Email - optional, nillable; type string
6. ManageCustomerRequest
   Source code
   Description:
   This operation allows a franchise administrator to manage individual customers. A new customer can be created (INSERT action), an existing customer can be modified (MODIFY action) or an existing customer configuration can be retrieved (GET action).
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://www.onlinembe.de/ws/ManageCustomerRequest
   Input:
   ManageCustomerRequestRequest (soap:body, use = literal)Source code
   parameters type ManageCustomerRequest

   • RequestContainer type ManageCustomerRequestType
     • SystemType type SystemType
       Important notice: This parameter is maintained for compatibility. It was created in previous version of this webservice but now it's completely useless. The system is defined by the calling url (www.onlinembe.de, new.onlinembe.es, etc), and one system can not return information from another instance.
       - type token with restriction - enumeration
       • IT
       • DE
       • ES
       • AT
       • FR
     • Credentials type CredentialsType
       The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
       • Username - type string with restriction maxLength(25)
         Client/admin username as used in OnlineMbe web interface.
       • Passphrase - type string with restriction maxLength(32)
         Passphrase for username. Must be given by the franchise administrator.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • Action - type string with restriction - enumeration
       • INSERT
       • MODIFY
       • GET
     • CustomerID - optional; type int
     • Customer type CustomerType
       • customerID - optional; type int
       • StoreID - optional; - type string with restriction length(4)
       • SamID - optional; - type string with restriction maxLength(11)
       • DepartmentID - optional; type int
       • Login - type string with restriction maxLength(25)
       • Password - optional; - type string with restriction maxLength(25)
       • CompanyName - optional; - type string with restriction maxLength(75)
       • CustomerName - optional; - type string with restriction maxLength(75)
       • VATNumber - optional; - type string with restriction maxLength(11)
       • Address - optional; - type string with restriction maxLength(100)
       • ZIPCode - optional; - type string with restriction maxLength(10)
       • City - optional; - type string with restriction maxLength(50)
       • State - optional; - type string with restriction length(2)
       • Country - optional; - type string with restriction maxLength(2)
       • Phone - optional; - type string with restriction maxLength(50)
       • Fax - optional; - type string with restriction maxLength(50)
       • Mobile - optional; - type string with restriction maxLength(50)
       • Email - optional; - type string with restriction maxLength(75)
       • Enabled - optional; type boolean
       • Permissions - optional; type Permissions
         • canSeeTracking - optional; type string
         • canSpecifyCOD - optional; type boolean
         • maxCODvalue - optional; type decimal
         • canSpecifyInsurance - optional; type boolean
         • maxInsuranceValue - optional; type decimal
         • canCreateCourierWaybill - optional; type boolean
         • canSpecifyCustomToSender - optional; type boolean
         • canSpecifySaturdayDelivery - optional; type boolean
         • canChooseMBEService - optional; type boolean
         • canChooseCourier - optional; type boolean
         • canChooseCourierService - optional; type boolean
         • canRequestImport - optional; type boolean
         • canChooseMBEShipType - optional; type boolean
         • canViewInvoices - optional; type boolean
         • canViewLoyalty - optional; type boolean
         • canUploadfiles - optional; type boolean
         • canDeleteShipments - optional; type boolean
         • enabledCouriers - optional; type string
         • enabledCourierServices - optional; type string
         • enabledCourierServicesDesc - optional; type string
         • canViewPricelist - optional; type boolean
         • maxShipmentWeight - optional; type decimal
         • maxParcelWeight - optional; type decimal
         • enabledServices - optional; type string
         • enabledServicesDesc - optional; type string
         • canSpecifyMBESafeValue - optional; type boolean
         • maxMBESafeValueValue - optional; type decimal
         • canReceiveNotificationsDeparture - optional; type boolean
         • canReceiveNotificationsDelivery - optional; type boolean
         • canReceiveNotificationsException - optional; type boolean
         • notificationEmail1 - optional; type string
         • notificationEmail2 - optional; type string
         • notificationEmail3 - optional; type string
         • notificationEmail4 - optional; type string
         • canPrintProforma - optional; type boolean
         • printInternalReferenceOnWaybill - optional; type boolean
         • hasAcceptedPrivacyAgreement - optional; type boolean
         • hasAcceptedTermsConditions - optional; type boolean
         • latestPickupTime - optional; type string
         • customsDutyToSenderUPSCode - optional; type string
         • customsDutyToSenderUPSZip - optional; type string
         • customsDutyToSenderFEDCode - optional; type string
         • customsDutyToSenderDHLCode - optional; type string
         • useCustomerAddressAsSender - optional; type boolean
         • useDepartmentAddressAsSender - optional; type boolean
         • canPrintManifest - optional; type boolean
         • isThermalLabel - optional; type boolean
         • isThermalLabelUPS - optional; type boolean
         • isThermalLabelFED - optional; type boolean
         • isThermalLabelSDA - optional; type boolean
         • isThermalLabelNEX - optional; type boolean
         • isThermalLabelCHX - optional; type boolean
         • isThermalLabelDHL - optional; type boolean
         • isThermalLabelDPD - optional; type boolean
         • isThermalLabelPOS - optional; type boolean
         • isThermalLabelSGT - optional; type boolean
         • isThermalLabelTNT - optional; type boolean
         • minShipmentWeight - optional; type decimal
         • minParcelWeight - optional; type decimal
         • defaultCODType - optional; - type token with restriction - enumeration
           • CASH
           • CHECK
         • canRequestReturn - optional; type boolean
         • canCreateCourierWaybillReturn - optional; type boolean
         • canSpecifyReturnOptionUPSPrintLabel - optional; type boolean
         • canSpecifyReturnOptionUPS1Attempt - optional; type boolean
         • canSpecifyReturnOptionUPS3Attempts - optional; type boolean
         • canSpecifyReturnOptionUPSElectronicLabel - optional; type boolean
         • canSpecifyReturnRecipientOptionCustomer - optional; type boolean
         • canSpecifyReturnRecipientOptionStore - optional; type boolean
         • canSpecifyReturnRecipientOptionDepartment - optional; type boolean
         • canSeeDetailedSurchargePrices - optional; type boolean
         • canSeeEstimatedDeliveryDates - optional; type boolean
         • warningOnPickups - optional; type string
         • isDimensionMandatory - optional; type boolean
         • isDisabledMultipleShipment - optional; type boolean
         • canUseDPDPredict - optional; type boolean
         • isChoosingDepartmentMandatory - optional; type boolean
         • closesShipmentsAutomatically - optional; type boolean
         • shipmentClosureTime - optional; type string
         • isUPSSignatureRequired - optional; type boolean
         • canSendEmailProductsOnClosure - optional; type boolean
         • canSelectShipmentValueCurrency - optional; type boolean
         • forceNotPrintInstrDocsTNT - optional; type boolean
         • addInternalNotesToMBEWaybill - optional; type boolean
         • canSaveAndShowPrice - optional; type boolean
         • showPriceOnMBEWaybill - optional; type boolean
         • canUploadShipments - optional; type boolean
         • attachProductExportToEmail - optional; type boolean
         • showSaveDefaultShipmentValues - optional; type boolean
         • sendUPSNotificationsToApiShipments - optional; type boolean
         • sendUPSDepartureNotificationsToApiShipments - optional; type boolean
         • sendUPSArrivalNotificationsToApiShipments - optional; type boolean
         • sendUPSExceptionNotificationsToApiShipments - optional; type boolean
         • sendDPDPredictNotificationsToApiShipments - optional; type boolean
         • sendDPDPredictNotificationChannelToApiShipments - optional; - type token with restriction - enumeration
           • EMAIL
           • SMS
         • enabledShipUAP - optional; type boolean
   Output:
   ManageCustomerRequestResponse (soap:body, use = literal)Source code
   parameters type ManageCustomerRequestResponse

   • RequestContainer type ManageCustomerResponseType
     • Status type StatusType
       This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
       - type token with restriction - enumeration
       • OK - The response indicates that the requested operation has been done without problems.
       • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
     • Errors - optional; type ErrorsType
       A list of the different errors that generated the ERROR status will be included here.
       • Error - unbounded; type ErrorType
         • Id type int
           A number that identifies this error. This number is guaranteed to be unique within a request context.
         • Description type string
           A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • Customer - optional; type CustomerType
       • customerID - optional; type int
       • StoreID - optional; - type string with restriction length(4)
       • SamID - optional; - type string with restriction maxLength(11)
       • DepartmentID - optional; type int
       • Login - type string with restriction maxLength(25)
       • Password - optional; - type string with restriction maxLength(25)
       • CompanyName - optional; - type string with restriction maxLength(75)
       • CustomerName - optional; - type string with restriction maxLength(75)
       • VATNumber - optional; - type string with restriction maxLength(11)
       • Address - optional; - type string with restriction maxLength(100)
       • ZIPCode - optional; - type string with restriction maxLength(10)
       • City - optional; - type string with restriction maxLength(50)
       • State - optional; - type string with restriction length(2)
       • Country - optional; - type string with restriction maxLength(2)
       • Phone - optional; - type string with restriction maxLength(50)
       • Fax - optional; - type string with restriction maxLength(50)
       • Mobile - optional; - type string with restriction maxLength(50)
       • Email - optional; - type string with restriction maxLength(75)
       • Enabled - optional; type boolean
       • Permissions - optional; type Permissions
         • canSeeTracking - optional; type string
         • canSpecifyCOD - optional; type boolean
         • maxCODvalue - optional; type decimal
         • canSpecifyInsurance - optional; type boolean
         • maxInsuranceValue - optional; type decimal
         • canCreateCourierWaybill - optional; type boolean
         • canSpecifyCustomToSender - optional; type boolean
         • canSpecifySaturdayDelivery - optional; type boolean
         • canChooseMBEService - optional; type boolean
         • canChooseCourier - optional; type boolean
         • canChooseCourierService - optional; type boolean
         • canRequestImport - optional; type boolean
         • canChooseMBEShipType - optional; type boolean
         • canViewInvoices - optional; type boolean
         • canViewLoyalty - optional; type boolean
         • canUploadfiles - optional; type boolean
         • canDeleteShipments - optional; type boolean
         • enabledCouriers - optional; type string
         • enabledCourierServices - optional; type string
         • enabledCourierServicesDesc - optional; type string
         • canViewPricelist - optional; type boolean
         • maxShipmentWeight - optional; type decimal
         • maxParcelWeight - optional; type decimal
         • enabledServices - optional; type string
         • enabledServicesDesc - optional; type string
         • canSpecifyMBESafeValue - optional; type boolean
         • maxMBESafeValueValue - optional; type decimal
         • canReceiveNotificationsDeparture - optional; type boolean
         • canReceiveNotificationsDelivery - optional; type boolean
         • canReceiveNotificationsException - optional; type boolean
         • notificationEmail1 - optional; type string
         • notificationEmail2 - optional; type string
         • notificationEmail3 - optional; type string
         • notificationEmail4 - optional; type string
         • canPrintProforma - optional; type boolean
         • printInternalReferenceOnWaybill - optional; type boolean
         • hasAcceptedPrivacyAgreement - optional; type boolean
         • hasAcceptedTermsConditions - optional; type boolean
         • latestPickupTime - optional; type string
         • customsDutyToSenderUPSCode - optional; type string
         • customsDutyToSenderUPSZip - optional; type string
         • customsDutyToSenderFEDCode - optional; type string
         • customsDutyToSenderDHLCode - optional; type string
         • useCustomerAddressAsSender - optional; type boolean
         • useDepartmentAddressAsSender - optional; type boolean
         • canPrintManifest - optional; type boolean
         • isThermalLabel - optional; type boolean
         • isThermalLabelUPS - optional; type boolean
         • isThermalLabelFED - optional; type boolean
         • isThermalLabelSDA - optional; type boolean
         • isThermalLabelNEX - optional; type boolean
         • isThermalLabelCHX - optional; type boolean
         • isThermalLabelDHL - optional; type boolean
         • isThermalLabelDPD - optional; type boolean
         • isThermalLabelPOS - optional; type boolean
         • isThermalLabelSGT - optional; type boolean
         • isThermalLabelTNT - optional; type boolean
         • minShipmentWeight - optional; type decimal
         • minParcelWeight - optional; type decimal
         • defaultCODType - optional; - type token with restriction - enumeration
           • CASH
           • CHECK
         • canRequestReturn - optional; type boolean
         • canCreateCourierWaybillReturn - optional; type boolean
         • canSpecifyReturnOptionUPSPrintLabel - optional; type boolean
         • canSpecifyReturnOptionUPS1Attempt - optional; type boolean
         • canSpecifyReturnOptionUPS3Attempts - optional; type boolean
         • canSpecifyReturnOptionUPSElectronicLabel - optional; type boolean
         • canSpecifyReturnRecipientOptionCustomer - optional; type boolean
         • canSpecifyReturnRecipientOptionStore - optional; type boolean
         • canSpecifyReturnRecipientOptionDepartment - optional; type boolean
         • canSeeDetailedSurchargePrices - optional; type boolean
         • canSeeEstimatedDeliveryDates - optional; type boolean
         • warningOnPickups - optional; type string
         • isDimensionMandatory - optional; type boolean
         • isDisabledMultipleShipment - optional; type boolean
         • canUseDPDPredict - optional; type boolean
         • isChoosingDepartmentMandatory - optional; type boolean
         • closesShipmentsAutomatically - optional; type boolean
         • shipmentClosureTime - optional; type string
         • isUPSSignatureRequired - optional; type boolean
         • canSendEmailProductsOnClosure - optional; type boolean
         • canSelectShipmentValueCurrency - optional; type boolean
         • forceNotPrintInstrDocsTNT - optional; type boolean
         • addInternalNotesToMBEWaybill - optional; type boolean
         • canSaveAndShowPrice - optional; type boolean
         • showPriceOnMBEWaybill - optional; type boolean
         • canUploadShipments - optional; type boolean
         • attachProductExportToEmail - optional; type boolean
         • showSaveDefaultShipmentValues - optional; type boolean
         • sendUPSNotificationsToApiShipments - optional; type boolean
         • sendUPSDepartureNotificationsToApiShipments - optional; type boolean
         • sendUPSArrivalNotificationsToApiShipments - optional; type boolean
         • sendUPSExceptionNotificationsToApiShipments - optional; type boolean
         • sendDPDPredictNotificationsToApiShipments - optional; type boolean
         • sendDPDPredictNotificationChannelToApiShipments - optional; - type token with restriction - enumeration
           • EMAIL
           • SMS
         • enabledShipUAP - optional; type boolean
7. ModifyDepartmentRequest
   Source code
   Description:
   This operation allows a franchise administrator to modify an existing department definition for a given customer.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://www.onlinembe.de/ws/ModifyDepartmentRequest
   Input:
   ModifyDepartmentRequestRequest (soap:body, use = literal)Source code
   parameters type ModifyDepartmentRequest

   • RequestContainer type ModifyDepartmentRequestType
     • Credentials type CredentialsType
       The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
       • Username - type string with restriction maxLength(25)
         Client/admin username as used in OnlineMbe web interface.
       • Passphrase - type string with restriction maxLength(32)
         Passphrase for username. Must be given by the franchise administrator.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • CustomerID type int
     • Department - unbounded; type ModifiedDepartmentType
       • ID type int
       • Name type string
       • SamID type string
       • ContactName - optional, nillable; type string
       • Address - optional, nillable; type string
       • Address2 - optional, nillable; type string
       • Address3 - optional, nillable; type string
       • ZipCode - optional, nillable; type string
       • City - optional, nillable; type string
       • State - optional, nillable; type string
       • SubzoneId - optional, nillable; type int
       • Country - optional, nillable; type string
       • Phone - optional, nillable; type string
       • Email - optional, nillable; type string
   Output:
   ModifyDepartmentRequestResponse (soap:body, use = literal)Source code
   parameters type ModifyDepartmentRequestResponse

   • RequestContainer type ModifyDepartmentResponseType
     • Status type StatusType
       This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
       - type token with restriction - enumeration
       • OK - The response indicates that the requested operation has been done without problems.
       • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
     • Errors - optional; type ErrorsType
       A list of the different errors that generated the ERROR status will be included here.
       • Error - unbounded; type ErrorType
         • Id type int
           A number that identifies this error. This number is guaranteed to be unique within a request context.
         • Description type string
           A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
8. PickupRequest
   Source code
   Description:
   Using this operation, a customer can create a new pickup request.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://www.onlinembe.de/ws/PickupRequest
   Input:
   PickupRequestRequest (soap:body, use = literal)Source code
   parameters type PickupRequest

   • RequestContainer type PickupRequestType
     • System type SystemType
       Important notice: This parameter is maintained for compatibility. It was created in previous version of this webservice but now it's completely useless. The system is defined by the calling url (www.onlinembe.de, new.onlinembe.es, etc), and one system can not return information from another instance.
       - type token with restriction - enumeration
       • IT
       • DE
       • ES
       • AT
       • FR
     • Credentials type CredentialsType
       The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
       • Username - type string with restriction maxLength(25)
         Client/admin username as used in OnlineMbe web interface.
       • Passphrase - type string with restriction maxLength(32)
         Passphrase for username. Must be given by the franchise administrator.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • Pickup type PickupType
       • PickupDate type date
       • PickupHour type string
       • NumberOfPackages type int
       • Instruction type string
   Output:
   PickupRequestResponse (soap:body, use = literal)Source code
   parameters type PickupRequestResponse

   • RequestContainer type PickupResponseType
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • Status type StatusType
       This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
       - type token with restriction - enumeration
       • OK - The response indicates that the requested operation has been done without problems.
       • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
     • Errors - optional; type ErrorsType
       A list of the different errors that generated the ERROR status will be included here.
       • Error - unbounded; type ErrorType
         • Id type int
           A number that identifies this error. This number is guaranteed to be unique within a request context.
         • Description type string
           A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
9. RecieversInsertRequest
   Source code
   Description:
   This operation is used to insert a new destination (receiver) for a given client.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://www.onlinembe.de/ws/RecieversInsertRequest
   Input:
   RecieversInsertRequestRequest (soap:body, use = literal)Source code
   parameters type RecieversInsertRequest

   • RequestContainer type RecieversInsertRequestType
     • Credentials type CredentialsType
       The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
       • Username - type string with restriction maxLength(25)
         Client/admin username as used in OnlineMbe web interface.
       • Passphrase - type string with restriction maxLength(32)
         Passphrase for username. Must be given by the franchise administrator.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
     • StoreID - type string with restriction length(4)
     • Reciever type RecieverToInsert
       • ClientID type int
       • email - nillable; type string
       • name - nillable; type string
       • surname - nillable; type string
       • company - nillable; type string
       • nickname - optional, nillable; type string
       • address - nillable; type string
       • city - nillable; type string
       • postal_code - nillable; type string
       • state - nillable; type string
       • country - nillable; type string
       • phone - nillable; type string
       • fax - nillable; type string
       • mobile - nillable; type string
       • idSubzone - nillable; type int
       • state_desc - nillable; type string
       • tax - nillable; type string
       • geocode_x - nillable; type double
       • geocode_y - nillable; type double
       • address2 - nillable; type string
       • address3 - nillable; type string
   Output:
   RecieversInsertRequestResponse (soap:body, use = literal)Source code
   parameters type RecieversInsertRequestResponse

   • RequestContainer type RecieversInsertResponseType
     • Status type StatusType
       This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
       - type token with restriction - enumeration
       • OK - The response indicates that the requested operation has been done without problems.
       • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
     • Errors - optional; type ErrorsType
       A list of the different errors that generated the ERROR status will be included here.
       • Error - unbounded; type ErrorType
         • Id type int
           A number that identifies this error. This number is guaranteed to be unique within a request context.
         • Description type string
           A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
     • InternalReferenceID type InternalReferenceIDType
       This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
       - type string with restriction maxLength(100)
10. RecieversListRequest
    Source code
    Description:
    RecieversListRequest operation allows an admin to retrieve the complete list of receivers for a given customer, indicated by its client id as an integer.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://www.onlinembe.de/ws/RecieversListRequest
    Input:
    RecieversListRequestRequest (soap:body, use = literal)Source code
    parameters type RecieversListRequest

    • RequestContainer type RecieversListRequestType
      • Credentials type CredentialsType
        The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
        • Username - type string with restriction maxLength(25)
          Client/admin username as used in OnlineMbe web interface.
        • Passphrase - type string with restriction maxLength(32)
          Passphrase for username. Must be given by the franchise administrator.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • ClientID type int
      • StoreID - type string with restriction length(4)
    Output:
    RecieversListRequestResponse (soap:body, use = literal)Source code
    parameters type RecieversListRequestResponse

    • RequestContainer type RecieversListResponseType
      • Status type StatusType
        This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
        - type token with restriction - enumeration
        • OK - The response indicates that the requested operation has been done without problems.
        • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
      • Errors - optional; type ErrorsType
        A list of the different errors that generated the ERROR status will be included here.
        • Error - unbounded; type ErrorType
          • Id type int
            A number that identifies this error. This number is guaranteed to be unique within a request context.
          • Description type string
            A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • Recievers - optional; type Recievers
        • Reciever - optional, unbounded; type Reciever
          • id type int
          • ClientID type int
          • email - nillable; type string
          • name - nillable; type string
          • surname - nillable; type string
          • company - nillable; type string
          • nickname - optional, nillable; type string
          • address - nillable; type string
          • city - nillable; type string
          • postal_code - nillable; type string
          • state - nillable; type string
          • country - nillable; type string
          • phone - nillable; type string
          • fax - nillable; type string
          • mobile - nillable; type string
          • idSubzone - nillable; type int
          • state_desc - nillable; type string
          • tax - nillable; type string
          • geocode_x - nillable; type double
          • geocode_y - nillable; type double
          • address2 - nillable; type string
          • address3 - nillable; type string
11. RecieversModifyRequest
    Source code
    Description:
    By using RecieversModifyRequest its possible to modify an existing destination for a given customer.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://www.onlinembe.de/ws/RecieversModifyRequest
    Input:
    RecieversModifyRequestRequest (soap:body, use = literal)Source code
    parameters type RecieversModifyRequest

    • RequestContainer type RecieversModifyRequestType
      • Credentials type CredentialsType
        The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
        • Username - type string with restriction maxLength(25)
          Client/admin username as used in OnlineMbe web interface.
        • Passphrase - type string with restriction maxLength(32)
          Passphrase for username. Must be given by the franchise administrator.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • StoreID - type string with restriction length(4)
      • Reciever type RecieverToModify
        • id type int
        • ClientID type int
        • email - optional, nillable; type string
        • name - optional, nillable; type string
        • surname - optional, nillable; type string
        • company - optional, nillable; type string
        • nickname - optional, nillable; type string
        • address - optional, nillable; type string
        • city - optional, nillable; type string
        • postal_code - optional, nillable; type string
        • state - optional, nillable; type string
        • country - optional, nillable; type string
        • phone - optional, nillable; type string
        • fax - optional, nillable; type string
        • mobile - optional, nillable; type string
        • idSubzone - optional, nillable; type int
        • state_desc - optional, nillable; type string
        • tax - optional, nillable; type string
        • geocode_x - optional, nillable; type double
        • geocode_y - optional, nillable; type double
        • address2 - optional, nillable; type string
        • address3 - optional, nillable; type string
    Output:
    RecieversModifyRequestResponse (soap:body, use = literal)Source code
    parameters type RecieversModifyRequestResponse

    • RequestContainer type RecieversModifyResponseType
      • Status type StatusType
        This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
        - type token with restriction - enumeration
        • OK - The response indicates that the requested operation has been done without problems.
        • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
      • Errors - optional; type ErrorsType
        A list of the different errors that generated the ERROR status will be included here.
        • Error - unbounded; type ErrorType
          • Id type int
            A number that identifies this error. This number is guaranteed to be unique within a request context.
          • Description type string
            A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
12. SetCustomerAsMigratedRequest
    Source code
    Description:
    This operation allows to set customers as migrated to teleport
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://www.onlinembe.de/ws/SetCustomerAsMigratedRequest
    Input:
    SetCustomerAsMigratedRequestRequest (soap:body, use = literal)Source code
    parameters type SetCustomerAsMigratedRequest

    • RequestContainer type SetCustomerAsMigratedRequestType
      • Credentials type CredentialsType
        The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
        • Username - type string with restriction maxLength(25)
          Client/admin username as used in OnlineMbe web interface.
        • Passphrase - type string with restriction maxLength(32)
          Passphrase for username. Must be given by the franchise administrator.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • TeleportCredentials type TeleportCredentialsType
        • TeleportCredential - unbounded; type TeleportCredentialType
          Credentials for a customer that must be migrated to Teleport. This parameter can be repeated as many times as needed, one for each customer.
          • CustomerID type int
          • Username - optional; type string
          • Password - optional; type string
    Output:
    SetCustomerAsMigratedRequestResponse (soap:body, use = literal)Source code
    parameters type SetCustomerAsMigratedRequestResponse

    • RequestContainer type SetCustomerAsMigratedResponseType
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • Status type StatusType
        This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
        - type token with restriction - enumeration
        • OK - The response indicates that the requested operation has been done without problems.
        • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
      • Errors - optional; type ErrorsType
        A list of the different errors that generated the ERROR status will be included here.
        • Error - unbounded; type ErrorType
          • Id type int
            A number that identifies this error. This number is guaranteed to be unique within a request context.
          • Description type string
            A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
13. SetCustomerVolumRequest
    Source code
    Description:
    SetCustomerVolumRequest allows the modification of volumetric divisor for a given customer.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://www.onlinembe.de/ws/SetCustomerVolumRequest
    Input:
    SetCustomerVolumRequestRequest (soap:body, use = literal)Source code
    parameters type SetCustomerVolumRequest

    • RequestContainer type SetCustomerVolumRequestType
      • Credentials type CredentialsType
        The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
        • Username - type string with restriction maxLength(25)
          Client/admin username as used in OnlineMbe web interface.
        • Passphrase - type string with restriction maxLength(32)
          Passphrase for username. Must be given by the franchise administrator.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • StoreID - type string with restriction length(4)
      • Divisors - unbounded; type Divisor
        • CustomerID type int
        • NationalDivisor type double
        • UEDivisor type double
        • WWDivisor type double
        • ServiceID type string
    Output:
    SetCustomerVolumRequestResponse (soap:body, use = literal)Source code
    parameters type SetCustomerVolumRequestResponse

    • RequestContainer type SetCustomerVolumResponseType
      • Status type StatusType
        This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
        - type token with restriction - enumeration
        • OK - The response indicates that the requested operation has been done without problems.
        • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
      • Errors - optional; type ErrorsType
        A list of the different errors that generated the ERROR status will be included here.
        • Error - unbounded; type ErrorType
          • Id type int
            A number that identifies this error. This number is guaranteed to be unique within a request context.
          • Description type string
            A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
14. SetDepartmentsRequest
    Source code
    Description:
    Using this operation a franchise administrator can create departments for a given customer, and assign them a SaM id.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://www.onlinembe.de/ws/SetDepartmentsRequest
    Input:
    SetDepartmentsRequestRequest (soap:body, use = literal)Source code
    parameters type SetDepartmentsRequest

    • RequestContainer type SetDepartmentsRequestType
      • Credentials type CredentialsType
        The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
        • Username - type string with restriction maxLength(25)
          Client/admin username as used in OnlineMbe web interface.
        • Passphrase - type string with restriction maxLength(32)
          Passphrase for username. Must be given by the franchise administrator.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • CustomerID type int
      • Department - optional, unbounded; type DepartmentType
        • Name type string
        • SamID type string
        • ContactName - optional, nillable; type string
        • Address - optional, nillable; type string
        • Address2 - optional, nillable; type string
        • Address3 - optional, nillable; type string
        • ZipCode - optional, nillable; type string
        • City - optional, nillable; type string
        • State - optional, nillable; type string
        • SubzoneId - optional, nillable; type int
        • Country - optional, nillable; type string
        • Phone - optional, nillable; type string
        • Email - optional, nillable; type string
    Output:
    SetDepartmentsRequestResponse (soap:body, use = literal)Source code
    parameters type SetDepartmentsRequestResponse

    • RequestContainer type SetDepartmentsResponseType
      • Status type StatusType
        This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
        - type token with restriction - enumeration
        • OK - The response indicates that the requested operation has been done without problems.
        • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
      • Errors - optional; type ErrorsType
        A list of the different errors that generated the ERROR status will be included here.
        • Error - unbounded; type ErrorType
          • Id type int
            A number that identifies this error. This number is guaranteed to be unique within a request context.
          • Description type string
            A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
15. ShipmentRequest
    Source code
    Description:
    The ShipmentRequest operation allows a client the creation of a new shipment on the OnlineMbe system.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://www.onlinembe.de/ws/ShipmentRequest
    Input:
    ShipmentRequestRequest (soap:body, use = literal)Source code
    parameters type ShipmentRequest

    • RequestContainer type ShipmentRequestType
      • System type SystemType
        Important notice: This parameter is maintained for compatibility. It was created in previous version of this webservice but now it's completely useless. The system is defined by the calling url (www.onlinembe.de, new.onlinembe.es, etc), and one system can not return information from another instance.
        - type token with restriction - enumeration
        • IT
        • DE
        • ES
        • AT
        • FR
      • Credentials type CredentialsType
        The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
        • Username - type string with restriction maxLength(25)
          Client/admin username as used in OnlineMbe web interface.
        • Passphrase - type string with restriction maxLength(32)
          Passphrase for username. Must be given by the franchise administrator.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • Recipient type RecipientType
        • Name - type string with restriction maxLength(35)
        • CompanyName - type string with restriction maxLength(35)
        • Nickname - optional; - type string with restriction maxLength(100)
        • Address - type string with restriction maxLength(100)
        • Address2 - optional; - type string with restriction maxLength(35)
        • Address3 - optional; - type string with restriction maxLength(35)
        • Phone - type string with restriction maxLength(50)
        • ZipCode - type string with restriction maxLength(12)
        • City - type string with restriction maxLength(50)
        • State - optional; - type string with restriction maxLength(2)
        • Country - type string with restriction maxLength(2)
        • Email - type string with restriction maxLength(75)
        • SubzoneId - optional; type int
        • SubzoneDesc - optional; type string
      • Shipment type ShipmentType
        • ShipperType - type string with restriction - enumeration
          • COURIERLDV
          • MBE
        • Description - type string with restriction maxLength(100)
        • COD type boolean
        • CODValue - optional; type decimal
        • MethodPayment - optional; - type string with restriction - enumeration
          • CASH
          • CHECK
        • Insurance type boolean
        • InsuranceValue - optional; type decimal
        • Service - optional; type string
        • Courier - optional; type string
        • CourierService - optional; type string
        • CourierAccount - optional; type string
        • PackageType - type token with restriction - enumeration
          • ENVELOPE
          • DOCUMENTS
          • GENERIC
        • Value - optional; type decimal
        • ShipmentCurrency - optional; type string
        • Referring - optional; - type string with restriction maxLength(30)
        • Items type ItemsType
          • Item - unbounded; type ItemType
            • Weight type decimal
            • Dimensions type DimensionsType
              • Lenght type decimal
              • Height type decimal
              • Width type decimal
        • Products - optional; type ProductsType
          • Product - unbounded; type ProductType
            • SKUCode type string
            • Description type string
            • Quantity type decimal
        • ProformaInvoice - optional; type ProformaInvoiceType
          • ProformaDetail - unbounded; type ProformaDetailType
            • Amount type int
            • Currency - type string with restriction maxLength(10)
            • Value type decimal
            • Unit - type string with restriction maxLength(5)
            • Description - type string with restriction maxLength(35)
        • InternalNotes - optional; type string
        • Notes - optional; type string
        • SaturdayDelivery - optional; type boolean
        • SignatureRequired - optional; type boolean
        • ShipmentOrigin - optional; - type string with restriction maxLength(50)
        • ShipmentSource - optional; type int
        • MBESafeValue - optional; type boolean
        • MBESafeValueValue - optional; type decimal
        • MBESafeValueDescription - optional; - type string with restriction maxLength(100)
        • LabelFormat - optional; - type token with restriction - enumeration
          • OLD
          • NEW
        • DepartmentID - optional; type int
    Output:
    ShipmentRequestResponse (soap:body, use = literal)Source code
    parameters type ShipmentRequestResponse

    • RequestContainer type ShipmentResponseType
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • Status type StatusType
        This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
        - type token with restriction - enumeration
        • OK - The response indicates that the requested operation has been done without problems.
        • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
      • Errors - optional; type ErrorsType
        A list of the different errors that generated the ERROR status will be included here.
        • Error - unbounded; type ErrorType
          • Id type int
            A number that identifies this error. This number is guaranteed to be unique within a request context.
          • Description type string
            A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
      • SystemReferenceID type SystemReferenceIDType - type string with restriction maxLength(30)
      • MasterTrackingMBE - optional; type string
      • TrackingsMBE - optional; type TrackingsMBEType
        • TrackingMBE - unbounded; type string
      • Labels - optional; type LabelsType
        • Label - unbounded; type LabelType
          • Stream type base64Binary
          • Type - type string with restriction maxLength(4)
      • CourierMasterTrk - optional; type string
16. ShipmentsListRequest
    Source code
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://www.onlinembe.de/ws/ShipmentsListRequest
    Input:
    ShipmentsListRequestRequest (soap:body, use = literal)Source code
    parameters type ShipmentsListRequest

    • RequestContainer type ShipmentsListRequestType
      • System type SystemType
        Important notice: This parameter is maintained for compatibility. It was created in previous version of this webservice but now it's completely useless. The system is defined by the calling url (www.onlinembe.de, new.onlinembe.es, etc), and one system can not return information from another instance.
        - type token with restriction - enumeration
        • IT
        • DE
        • ES
        • AT
        • FR
      • Credentials type CredentialsType
        The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
        • Username - type string with restriction maxLength(25)
          Client/admin username as used in OnlineMbe web interface.
        • Passphrase - type string with restriction maxLength(32)
          Passphrase for username. Must be given by the franchise administrator.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • StoreID - type string with restriction length(4)
      • CustomerID - optional; type int
      • DateFrom - optional; type date
      • DateTo - optional; type date
      • MBEMasterTrackings - optional, unbounded; - type string with restriction maxLength(20)
      • MBESafeValue - optional; type boolean
      • WithCourierWaybill - optional; type boolean
      • PendingExportToSAM - optional; type boolean
    Output:
    ShipmentsListRequestResponse (soap:body, use = literal)Source code
    parameters type ShipmentsListRequestResponse

    • RequestContainer type ShipmentsListResponseType
      • Status type StatusType
        This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
        - type token with restriction - enumeration
        • OK - The response indicates that the requested operation has been done without problems.
        • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • Errors - optional; type ErrorsType
        A list of the different errors that generated the ERROR status will be included here.
        • Error - unbounded; type ErrorType
          • Id type int
            A number that identifies this error. This number is guaranteed to be unique within a request context.
          • Description type string
            A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
      • ShipmentsFullInfo - optional; type ShipmentsFullInfoType
        • ShipmentFullInfo - optional, unbounded; type ShipmentFullInfoType
          • ReceiverInfo type ReceiverInfoType
            • CompanyName - nillable; type string
            • Name - nillable; type string
            • Address - nillable; type string
            • ZipCode - nillable; type string
            • City - nillable; type string
            • State - nillable; type string
            • Country - nillable; type string
            • Phone - nillable; type string
            • Emails - unbounded, nillable; - type string with restriction maxLength(75)
          • ShipmentInfo type ShipmentInfoType
            • Description - optional; type string
            • COD type boolean
            • CODValue - optional; type decimal
            • Insurance type boolean
            • InsuranceValue - optional; type decimal
            • MethodPayment - optional; - type string with restriction - enumeration
              • CASH
              • CHECK
            • MBEService - optional; type string
            • Courier - optional; type string
            • CourierService - optional; type string
            • PackageType type string
            • Items type ItemsType
              • Item - unbounded; type ItemType
                • Weight type decimal
                • Dimensions type DimensionsType
                  • Lenght type decimal
                  • Height type decimal
                  • Width type decimal
            • Date type dateTime
          • TrackingInfo type TrackingInfoType
            • MasterTrackingMBE - optional; type string
            • TrackingsMBE - optional; type TrackingsMBEType
              • TrackingMBE - unbounded; type string
            • Labels - optional; type LabelsType
              • Label - unbounded; type LabelType
                • Stream type base64Binary
                • Type - type string with restriction maxLength(4)
            • CourierMasterTrk - optional; type string
17. ShippingOptionsRequest
    Source code
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://www.onlinembe.de/ws/ShippingOptionsRequest
    Input:
    ShippingOptionsRequestRequest (soap:body, use = literal)Source code
    parameters type ShippingOptionsRequest

    • RequestContainer type ShippingOptionsRequestType
      • System type SystemType
        Important notice: This parameter is maintained for compatibility. It was created in previous version of this webservice but now it's completely useless. The system is defined by the calling url (www.onlinembe.de, new.onlinembe.es, etc), and one system can not return information from another instance.
        - type token with restriction - enumeration
        • IT
        • DE
        • ES
        • AT
        • FR
      • Credentials type CredentialsType
        The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
        • Username - type string with restriction maxLength(25)
          Client/admin username as used in OnlineMbe web interface.
        • Passphrase - type string with restriction maxLength(32)
          Passphrase for username. Must be given by the franchise administrator.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • ShippingParameters type ShippingParametersType
        • DestinationInfo type DestinationInfoType
          • ZipCode - type string with restriction maxLength(12)
          • City - optional; - type string with restriction maxLength(50)
          • State - optional; - type string with restriction maxLength(2)
          • Country - type string with restriction maxLength(2)
          • idSubzone - optional; type int
        • ShipType - type token with restriction - enumeration
          • EXPORT
          • IMPORT
          • RETURN
        • PackageType - type token with restriction - enumeration
          • ENVELOPE
          • DOCUMENTS
          • GENERIC
        • Service - optional; type string
        • Courier - optional; type string
        • CourierService - optional; type string
        • Items type ItemsType
          • Item - unbounded; type ItemType
            • Weight type decimal
            • Dimensions type DimensionsType
              • Lenght type decimal
              • Height type decimal
              • Width type decimal
        • COD - optional; type boolean
        • CODValue - optional; type decimal
        • CODPaymentMethod - optional; - type token with restriction - enumeration
          • CASH
          • CHECK
        • Insurance - optional; type boolean
        • InsuranceValue - optional; type decimal
        • SaturdayDelivery - optional; type boolean
        • SignatureRequired - optional; type boolean
        • MBESafeValue - optional; type boolean
        • MBESafeValueValue - optional; type decimal
    Output:
    ShippingOptionsRequestResponse (soap:body, use = literal)Source code
    parameters type ShippingOptionsRequestResponse

    • RequestContainer type ShippingOptionsResponseType
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • Status type StatusType
        This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
        - type token with restriction - enumeration
        • OK - The response indicates that the requested operation has been done without problems.
        • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
      • Errors - optional; type ErrorsType
        A list of the different errors that generated the ERROR status will be included here.
        • Error - unbounded; type ErrorType
          • Id type int
            A number that identifies this error. This number is guaranteed to be unique within a request context.
          • Description type string
            A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
      • ShippingOptions - optional; type ShippingOptionsType
        • ShippingOption - unbounded; type ShippingOptionType
          • Service type string
          • ServiceDesc type string
          • Courier type string
          • CourierDesc type string
          • CourierService type string
          • CourierServiceDesc type string
          • NetShipmentPrice type decimal
          • NetShipmentTotalPrice type decimal
          • CODAvailable type boolean
          • InsuranceAvailable type boolean
          • IdSubzone type int
          • SubzoneDesc type string
          • MBESafeValueAvailable type boolean
18. TrackingRequest
    Source code
    Description:
    TrackingRequest is used to retrieve tracking information of an existing shipment from a given customer.
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    https://www.onlinembe.de/ws/TrackingRequest
    Input:
    TrackingRequestRequest (soap:body, use = literal)Source code
    parameters type TrackingRequest

    • RequestContainer type TrackingRequestType
      • System type SystemType
        Important notice: This parameter is maintained for compatibility. It was created in previous version of this webservice but now it's completely useless. The system is defined by the calling url (www.onlinembe.de, new.onlinembe.es, etc), and one system can not return information from another instance.
        - type token with restriction - enumeration
        • IT
        • DE
        • ES
        • AT
        • FR
      • Credentials type CredentialsType
        The Credentials type is the authentication information required to access OnlineMbe data. It's composed of Username and Passphrase parameters. Username is the same username assigned to the customer (or franchise administrator) to access OnlineMbe's web client. Passphrase is constant to each username (can not be changed), and it's accessed by administrator clients on OnlineMbe web client thru https://www.onlinembe.de/admin_generatePassphrase.jsf . The username and passphrase will authenticate and restrict what operations can be done by that user.
        • Username - type string with restriction maxLength(25)
          Client/admin username as used in OnlineMbe web interface.
        • Passphrase - type string with restriction maxLength(32)
          Passphrase for username. Must be given by the franchise administrator.
      • InternalReferenceID type InternalReferenceIDType
        This field will be returned in the response without modification. It has no direct meaning to OnlineMbe and should be used by client to maintain a reference between requests and responses.
        - type string with restriction maxLength(100)
      • TrackingMBE - type string with restriction maxLength(20)
    Output:
    TrackingRequestResponse (soap:body, use = literal)Source code
    parameters type TrackingRequestResponse

    • RequestContainer type TrackingResponseType
      • Status type StatusType
        This parameter indicates if there has been some error at the operation indicated in the request. It can have two values, OK if the request could be accomplished or ERROR when some exception has not allowed it.
        - type token with restriction - enumeration
        • OK - The response indicates that the requested operation has been done without problems.
        • ERROR - Some error or exception has prevented the correct finalization of the requested operation.
      • Errors - optional; type ErrorsType
        A list of the different errors that generated the ERROR status will be included here.
        • Error - unbounded; type ErrorType
          • Id type int
            A number that identifies this error. This number is guaranteed to be unique within a request context.
          • Description type string
            A textual representation of the error indicating what's wrong in the request or what happened that has prevented the finalization of this operation.
      • TrackingStatus - optional; - type string with restriction - enumeration
        • DELIVERED
        • PARTIALLY_DELIVERED
        • WAITING_DELIVERY
        • NOT_AVAILABLE
        • EXCEPTION
      • DeliveryDate - optional; type date
      • DeliverySign - optional; type string