|
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
|
|
|
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
|
|
| email |
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
|
|
|
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
|
|
|
getOptionTextType |
|---|
| environment |
M
|
environmentType |
| messageLevel |
O
|
int |
| optionSelection |
M
|
optionSelectionRequestType |
|
getCustomTextResponseType |
|---|
| environment |
M
|
environmentType |
| response |
M
|
responseType |
| optionTextList |
M
|
textTranslationsResponseType |
|
setOptionTextType |
|---|
| environment |
M
|
environmentType |
| messageLevel |
O
|
string |
| optionText |
M
|
optionTextListType |
| writeMode
[?] insert|update|copy
|
O
|
string |