| environmentType Contains environment variables for in- and or output. Some variables are only for input or output. | ||
|---|---|---|
| partyGroupName
[?]
The name of the party group corresponding to the
certificate. [input|output]
|
O | |
| partyGroupCode
[?]
A class name of party group for special cases.
[input]
|
O | |
| portalName
[?]
The name of a calling portal. [input|output]
|
O | |
| countryCode
[?]
Country code for localization control.
[input|output] Format ISO 3166, 2 letters
|
M | |
| languageCode
[?]
Language code for localization control.
[input|output] Format ISO 639-1, 2 letters
|
M | |
| currencyCode
[?]
Currency code. [output] Format ISO 4217, 3
letters
|
O | |
| currencySymbol
[?]
Specal character for currency outputs. [output]
|
O | |
| partyId
[?]
Internal customer id is required in special
cases. [input]
|
O | |
| availabilityTypeId
[?]
A uniqe id to mark different applications
[input]
|
O | |
| partnerDomain | O | |
| currencyBeforePrice | O | |
| responseType | ||
|---|---|---|
| responseCode
[?] Possible values: 1.. request okay| 0.. request has an error
|
M | |
| responseMessages
[?] Array of messages
|
O , ∞ | responseMessageType |
| responseMessageType | ||
|---|---|---|
| returnCode
[?] message code. See http://interface.unitedprint.com.lilo.print24test.de/doc2.1/messageCodes.html
|
M | |
| returnMessage
[?] message text
|
M | |
| accountType Structure for identifying a particular user. | ||
|---|---|---|
| partyGroupName
[?] The name of the party group corresponding to the certificate.
|
O | |
| customerNumber
[?] The official number of a customer issued by Unitedprint.
|
O | |
| partyId
[?] Internal customer id is requied by special cases.
|
O | |
| email
[?] The email address corrensponding to the customers profile.
Is used as account name here.
|
O | |
| password
[?] The password for the calling user.
|
O | |
| parameterType | ||
|---|---|---|
| name | M | |
| value | O | |
| id | O | |
| orderDescriptionRank | O | |
| longAddressType | ||
|---|---|---|
| addressId
[?]
You can get a address id from customer module.
If you use this id here, then all other fields
was ignored. See also getCustomerAddress
|
O | |
| addressType
[?]
This field is only for output. DBA: different
billing address DSA: different shipping address
ASA: addidional shipping address
|
O | |
| company
[?] max length 128
|
O | |
| salutation
[?]
possible values are Herr|Frau
|
O | |
| firstName
[?] max length 64
|
O | |
| lastName
[?] max length 64
|
O | |
| street
[?] max length 100
|
O | |
| housenumber
[?] max length 8
|
O | |
| digicode | O | |
| zipcode
[?] max length 20
|
O | |
| city
[?] max length 100
|
O | |
| county
[?]
This ist only for countries without zipcode
e.eg. Ireland max length 64
|
O | |
| country
[?]
This ist only for countries without zipcode
e.eg. Ireland max length 64
|
O | |
| countyCode
[?]
Format ISO 3166, 2 characters
|
O | |
| VATNumberValue | O | |
| VATNumberType | O | |
| additionalLine
[?] max length 100
|
O | |
| phonePrefix
[?] max length 10
|
O | |
| phoneNumber
[?] max length 20
|
O | |
| O | ||
| AddressType | ||
|---|---|---|
| companyName
[?] max length 128
|
O | |
| gender
[?] gender = [ m | f ]
|
O | |
| firstName
[?] max length 64
|
O | |
| lastName
[?] max length 64
|
O | |
| street
[?] max length 100
|
O | |
| houseNumber
[?] You can set the housenumber in street variable also. max length 8
|
O | |
| postCode
[?] max length 10
|
O | |
| city
[?] max length 100
|
O | |
| county
[?] Only for countries without postal code. E.g. Ireland max length 64
|
O | |
| country
[?] Format ISO 3166, 2 characters
|
O | |
| digicode
[?] Special access codes for deliverer. max length 12
|
O | |
| additionalLine
[?] max length 100
|
O | |
| phonePrefix
[?] max length 10
|
O | |
| phoneNumber
[?] max length 20
|
O | |
| email
[?] max length 100
|
O | |
| orderAddressType | ||
|---|---|---|
| addressId
[?]
You can get a address id from customer module.
If you use this id here, then all other fields
excluding partialQuantity was ignored.
See also getCustomerAddress
|
O | |
| partialQuantity
[?]
The quantity for this shipment.
|
M | |
| company
[?] max length 128
|
O | |
| salutation
[?] possible values are Herr|Frau
|
O | |
| firstName
[?] max length 64
|
O | |
| lastName
[?] max length 64
|
O | |
| street
[?] max length 100
|
O | |
| houseNumber
[?] You can set the housenumber in street variable also.
max length 8
|
O | |
| zipcode
[?] max length 10
|
O | |
| city
[?] max length 100
|
O | |
| county
[?] Only for countries without zipcode. E.g. Ireland
max length 64
|
O | |
| country
[?] Format ISO 3166, 2 characters
|
O | |
| digicode
[?] Special access codes for deliverer.
max length 12
|
O | |
| additionalLine
[?] max length 100
|
O | |
| phonePrefix
[?] max length 10
|
O | |
| phoneNumber
[?] max length 20
|
O | |
| email
[?] max length 100
|
O | |
| shortAddressType | ||
|---|---|---|
| adressId
[?] You can get a address id from customer module.
If you use this id here, then all other fields was ignored.
See also getCustomerAddress.
|
O | |
| company
[?] max length 128
|
O | |
| salutation
[?] possible values are Herr|Frau
|
O | |
| firstName
[?] max length 64
|
O | |
| lastName
[?] max length 64
|
O | |
| street
[?] max length 100
|
O | |
| city
[?] max length 100
|
O | |
| zipcode
[?] max length 20
|
O | |
| county
[?] max length 64
|
O | |
| country
[?] Format ISO 3166, 2 characters
|
O | |
| pairOfValueType | ||
|---|---|---|
| name | M | |
| value | O | |
| pairOfStrings | ||
|---|---|---|
| oldOptionText | M | |
| newOptionText | M | |
| productImageType | ||
|---|---|---|
| front | M | perspectiveType |
| back | M | perspectiveType |
| frontRight | O | perspectiveType |
| frontLeft | O | perspectiveType |
| frontThumbnail | O | perspectiveType |
| backThumbnail | O | perspectiveType |
| productInfoImageType | ||
|---|---|---|
| path | M | |
| text | O , ∞ | |
| productDescriptionTooltipType | ||
|---|---|---|
| path | M | |
| text | O , ∞ | |
| layout | O , ∞ | |
| selectedType | ||
|---|---|---|
| catalogueIdent
[?] not used
|
O | |
| itemId
[?]
item id from itemmaster (the UP system core)
|
O | |
| itemGroupId
[?]
id of item group like flyer, poster, tshirt (UP
system core)
|
O | |
| itemIdentifier
[?]
customers name of a item
|
O | |
| internalId
[?]
id corresponds itemIdentifier
|
O | |
| catalogueIdentCode
[?]
product group like PAPER, MATERIAL_PRINT,
COVER_CONTENT
|
O | |
| propertyIds
[?]
set of properties contained in selected product,
corresponds property names This is usefull for a
design application.
|
O , ∞ | parameterType |
| propertyNames
[?]
set of property names contained in selected
product like format, seiten, papier,..
|
O , ∞ | pairOfValueType |
| variantIds
[?]
set of variant ids contained in selected product
like aspect ratio
|
O , ∞ | parameterType |
| optionIds
[?]
set of option ids that make up the selected
product
|
O , ∞ | parameterType |
| productProperties
[?]
set of physical properties of the selected
product like length, width, height,..
|
O , ∞ | pairOfValueType |
| itemVariantIds
[?]
item specific variant ids, correnponds with item
id and variant ids
|
O , ∞ | parameterType |
| priceNet
[?] price without tax
|
O | |
| priceGross
[?] price included tax
|
O | |
| shippingGross | O | |
| shippingNet | O | |
| emphasizeType
[?]
type of itemidentifier like USR or another
customer defined groups
|
O | |
| emphasizeViewGroup
[?]
products can assigned to different views
|
O | |
| productName
[?]
name of product/product group in view
|
O | |
| productImage
[?]
images for product layouting
|
O | productImageType |
| productInfoImage
[?]
info images for product details
|
O | productInfoImageType |
| changedOptions
[?]
contains options that have been replaced while
select the product from catalogue, eg option is
not longer valid
|
O , ∞ | pairOfStrings |
| changedOptionsFlag
[?]
contains the flag which indicates differences between
requested and responded options
|
O | |
| templateIdentifier
[?]
name af a template for product designing in a
application
|
O | |
| productNameSingular
[?]
the internal name of product, not the
translation
|
O | |
| availabilityTypeId
[?]
classified a frontend application type
|
O | |
| shippingDestination
[?]
shipping destination country code ISO3166
|
O | |
| shippingDestinationChoice
[?]
get a structure of all possible shipping
destinations and services
|
O | |
| accessoryItemId
[?]
id for a refered product
|
O | |
| bleedList | O | bleedListType |
| marginList | O | bleedListType |
| overlapList | O | bleedListType |
| foldInformationList | O | foldInfoListType |
| safetyBleedSize | O | |
| bleedHintPosition | O | |
| showSpecialButtons | O | |
| mask
[?]
fxg mask for product background image
|
O | |
| nonprintingArea
[?]
fxg data for nonprinting area
|
O | |
| designScheme
[?]
fxg data for design scheme
|
O | |
| delivery | O | |
| purchasable | O | |
| dpi
[?]
picture resulution in dot pro inch
|
O | |
| bleedListType | ||
|---|---|---|
| top | O | |
| right | O | |
| bottom | O | |
| left | O | |
| foldInfoListType | ||
|---|---|---|
| isFront | O | |
| point1X | O | |
| point1Y | O | |
| point2X | O | |
| point2Y | O | |
| path | O | |
| productViewsType | ||
|---|---|---|
| texts | O , ∞ | |
| productViewsElements | M , ∞ | productViewsElements |
| externalLinkType | ||
|---|---|---|
| url | M | |
| text | M | |
| linkTypeName | O | |
| optionListType | ||
|---|---|---|
| optionId | O | |
| optionName | M | |
| optionValue | O | |
| optionDescription | O | |
| optionTranslations | O , ∞ | |
| optionRankInternal | O | |
| optionRankLogical | O | |
| active | M | |
| priceGross | O | |
| priceNet | O | |
| itemGroupId | M | |
| propertyIds | O , ∞ | parameterType |
| variantIds | O , ∞ | parameterType |
| exclusive | O | |
| externalLinks | O , ∞ | externalLinkType |
| productDescriptionTooltip | O | productDescriptionTooltipType |
| orderDescriptionRank | O | |
| isFree | O | |
| displayColumn | M | |
| catalogueCode | M | |
| orderable | M | |
| grayed | O | |
| isNew | O | |
| selectGroupListType | ||
|---|---|---|
| selectId | O | |
| selectName | M | |
| selectRank | O | |
| selectDescription | O | |
| selectTranslations | M , ∞ | |
| headlines | M , ∞ | |
| optionList | M , ∞ | optionListType |
| selectType | O | |
| displayMax | O | |
| displayMin | O | |
| displayStep | O | |
| menuRank | O | |
| menuPosition | O | |
| hidden [?] | O | |
| productListType | ||
|---|---|---|
| selectGroupList | M , ∞ | selectGroupListType |
| selected | M | selectedType |
| productViews | M , ∞ | productViewsType |
| universalAccountType | ||
|---|---|---|
| partyGroupName | O | |
| customerNumber | O | |
| customerRelation | O | |
| portalName | M | |
| countryCode | M | |
| languageCode | O | |
| login | O | |
| password | M | |
| productViewElement |
|---|
| productViewsElements | ||
|---|---|---|
| texts | O | |
| isNew | O | |
| orderable | M | |
| active | M | |
| internalId | M | |
| externalLinks | O , ∞ | externalLinkType |
| itemGroupName | M | |
| rangeType | ||
|---|---|---|
| lower
[?] lower limit
|
M | |
| upper
[?] upper limit
|
O | |
| variantType | ||
|---|---|---|
| variantName
[?] variant type name [ special format | font | free_form | page_counter | front | cover_front | cover_back | back ]
|
O | |
| variantValueName
[?] variant type name [ special format | font | free_form | special color | lining | page_counter | special color inclusive ]
|
M | |
| variantValueType
[?] specific variant value name [ font_name | height | farbenI | farben | farbenU | start_count | finish_count | width ]
|
M | |
| variantValue
[?] any existing value [ float, int, string ]
|
M | |
| getAddress | getAddressType |
| getAddressType | ||
|---|---|---|
| addressSearch | O | shortAddressType |
| messageLevel | M | string |
| profileInformationType | ||
|---|---|---|
| CustomerNumber | M | |
| Language | O | |
| CountryCode | O | |
| PartyId | M | int |
| AddressId | M | int |
| AddressType | M | string |
| CustomerType | M | string |
| Company | M | string |
| LegalForm | M | string |
| Business | M | string |
| Salutation | M | string |
| FirstName | M | string |
| LastName | M | string |
| Birthday | M | string |
| Street | M | string |
| HouseNumber | M | string |
| Zipcode | M | string |
| City | M | string |
| County | M | string |
| Digicode | M | string |
| VATNumberValue | M | string |
| VATNumberType | M | string |
| AdditionalLine | M | string |
| PhonePrefix1 | M | string |
| PhoneNumber1 | M | string |
| PhonePrefix2 | M | string |
| PhoneNumber2 | M | string |
| getAddressResponse | getAddressResponseType |
| getAddressResponseType | ||
|---|---|---|
| accountInformation | M | accountType |
| addressInformation | O | addressInformationType |
| response | M | responseType |
| addressInformationType | ||
|---|---|---|
| addressList | O , ∞ | longAddressType |
| putAddress | putAddressType |
| putAddressResponse | putAddressResponseType |
| putAddressType | ||
|---|---|---|
| environment | M | environmentType |
| messageLevel | O | |
| addressInformation | M | longAddressType |
| putAddressResponseType | ||
|---|---|---|
| response | M | responseType |
| putProfile | putProfileType |
| putProfileResponse | putProfileResponseType |
| putProfileType | ||
|---|---|---|
| environment | M | environmentType |
| customerProfile | M | customerProfileType |
| messageLevel | O | |
| customerProfileType | ||
|---|---|---|
| O | ||
| customerNumber | O | |
| kindCustomer | O | |
| phoneCountry | O | |
| faxPredial | O | |
| faxNumber | O | |
| mobilePredial | O | |
| mobileNumber | O | |
| birthdate | O | |
| uidNr | O | |
| VATNumberValue | O | |
| VATNumberType | O | |
| userAddress | O | longAddressType |
| partySubtypeName | O | |
| partyTypeDescription | O | |
| partyGroupId | O | |
| partyGroupName | O | |
| partyGroupTypeName | O | |
| representator | O | |
| department | O | |
| legalForm | O | |
| timeZone | O | |
| language | O | |
| password | O | |
| attentionGetter | O | |
| putProfileResponseType | ||
|---|---|---|
| response | M | responseType |
| getProfile | getProfileType |
| getProfileType | ||
|---|---|---|
| accountInformation | M | accountType |
| messageLevel | O | |
| getProfileResponse | getProfileResponseType |
| getProfileResponseType | ||
|---|---|---|
| accountInformation | M | accountType |
| customerProfile | O | customerProfileType |
| response | M | responseType |
| createCertificate | createCertificateComplexType |
| createCertificateResponse | createCertificateResponseComplexType |
| createCertificateComplexType | ||
|---|---|---|
| environment | M | environmentType |
| messageLevel | O | |
| customerNumber | M | |
| certificateListType | ||
|---|---|---|
| certificateParts | O | certificatePartsType |
| createCertificateResponseComplexType | ||
|---|---|---|
| environment | M | environmentType |
| response | M | responseType |
| certificateList | M | certificateListType |
| certificatePartsType | ||
|---|---|---|
| certPEM | M | |
| privateKeyPEM | M | |
| getOrderHeaders | getOrderHeadersComplexType |
| getOrderHeadersResponse | getOrderHeadersResponseComplexType |
| getWholeOrder | getWholeOrderComplexType |
| getWholeOrderResponse | getWholeOrderResponseComplexType |
| getOrderHeadersComplexType | ||
|---|---|---|
| environment | M | environmentType |
| messageLevel | O | |
| selection | O | selectionType |
| selectionType | ||
|---|---|---|
| state | O | |
| pos | O | |
| limit | O | |
| getOrderHeadersResponseComplexType | ||
|---|---|---|
| environment | M | environmentType |
| response | M | responseType |
| orderHeaders | O | orderHeadersType |
| getWholeOrderComplexType | ||
|---|---|---|
| environment | M | environmentType |
| messageLevel | M | |
| orderNumber | O | |
| orderName | O | |
| orderDateFrom | O | |
| orderDateTo | O | |
| orderHeadersType | ||
|---|---|---|
| orderHeaderList | O , ∞ | orderHeaderType |
| getWholeOrderResponseComplexType | ||
|---|---|---|
| environment | M | environmentType |
| response | M | responseType |
| order | M | orderType |
| orderType | ||
|---|---|---|
| orderHeader | M | orderHeaderType |
| orderLines | M , ∞ | orderLinesType |
| customer | O | customerComplexType |
| customerComplexType | ||
|---|---|---|
| partyId | M | |
| customerNumber | M | |
| orderLinesType | ||
|---|---|---|
| orderLineId | M | |
| orderLineSourceId | O | |
| lineNumber | O | |
| orderedDate | O | |
| deliveryDate | O | |
| deliveryDays | O | |
| shipmentScheduleDate | O | |
| shipmentDate | O | |
| measureId | O | |
| orderQuantity | O | |
| orderedItem | O | |
| orderCode | O | |
| itemName | O | |
| taxGroupId | O | |
| taxValue | O | |
| taxRate | O | |
| sellingPrice | O | |
| clearance | O | |
| clearanceDate | O | |
| consignmentType | O | |
| lineType | O | |
| lineTypeDescription | O | |
| receiverAddress | O | longAddressType |
| senderAddress | O | longAddressType |
| stateNumber | O | |
| stateName | O | |
| customerComment | O | |
| orderHeaderType | ||
|---|---|---|
| orderHeaderId | M | |
| orderHeaderSourceId | O | |
| availabilityTypeId | O | |
| orderTypeId | O | |
| orderNumber | O | |
| orderedDate | O | |
| countryCode | O | |
| currencyCode | O | |
| conversionRate | O | |
| paymentTermId | O | |
| paymentMethodId | O | |
| paid | O | |
| paidDate | O | |
| partialShipmentsAllowed | O | |
| invoiceAddress | O | longAddressType |
| whoAmI | whoAmIComplexType |
| whoAmIResponse | whoAmIResponseComplexType |
| whoAmIComplexType | ||
|---|---|---|
| accountInformation | M | universalAccountType |
| messageLevel | O | |
| whoAmIResponseComplexType | ||
|---|---|---|
| environment | M | environmentType |
| customer | M | customerProfileType |
| response | M | responseType |
| getPartyGroupMembers | getPartyGroupMembersComplexType |
| getPartyGroupMembersResponse | getPartyGroupMembersResponseComplexType |
| getPartyGroupMembersComplexType | ||
|---|---|---|
| environment | M | environmentType |
| messageLevel | O | |
| getPartyGroupMembersResponseComplexType | ||
|---|---|---|
| environment | M | environmentType |
| response | M | responseType |
| partyGroupMembers | M , ∞ | partyGroupMembersType |
| partyGroupMembersType | ||
|---|---|---|
| partyGroupMembersList | M | partyGroupMembersListType |
| partyGroupMembersListType | ||
|---|---|---|
| partyId | M | |
| userAddress | O | longAddressType |
| getAddress | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||
| putAddress | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||
| putProfile | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||
| getProfile | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||
| createCertificate | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||
| getOrderHeaders | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||
| getWholeOrder | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||
| whoAmI | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||
| getPartyGroupMembers | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||