| 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 | |
| createOrder | createOrderRequestType |
| createOrderResponse | createOrderResponseType |
| createServiceOrder | createServiceOrderRequestType |
| createServiceOrderResponse | createServiceOrderResponseType |
| sendOrder | sendOrderRequestType |
| sendOrderResponse | sendOrderResponseType |
| createServiceOrderRequestType | ||
|---|---|---|
| environment
[?] portal and client data
|
M | environmentType |
| accountInformation
[?] A order request requires a login.
|
M | accountType |
| serviceOrder | M | serviceOrderType |
| paymentInformation
[?] Information about the payment modalities.
|
M | paymentDataType |
| messageLevel
[?] messageLevel = [ all | medium | silent ]
|
O | string |
| serviceOrderType | ||
|---|---|---|
| header | M | serviceOrderHeaderType |
| lines | M | serviceOrderLineType |
| serviceOrderHeaderType | ||
|---|---|---|
| orderNumber
[?] ordernumber of the service order of partnershop
|
M | int |
| provisionRate
[?] rate of provision for that order that's produced by the partner as multiplicator, e.g. 0.2.
|
M | float |
| serviceOrderLines | ||
|---|---|---|
| line | M , 99 | serviceOrderLineType |
| serviceOrderLineType | ||
|---|---|---|
| productName
[?] The name of the (kind of) product that has been produced by partnershop. Can be localized and doesn't need to accord to UP products.
|
M | string |
| lineNumber
[?] The number of the position within the order.
|
M | int |
| consignmentType
[?] consignmentType = [ EXP | OVN | STD | ECO ]
|
M | string |
| sellingPrice
[?] net price of product
|
M | float |
| itemGroupViewElementId
[?] view id to determine item group id
|
M | int |
| orderQuantity
[?] amount of ordered products
|
M | int |
| deliveryDate
[?] delivery date set by partnershop
|
M | string |
| deliveryDays
[?] days until delivery set by partnershop
|
M | int |
| customerComment
[?] customer comment
|
M | string |
| createServiceOrderResponseType | ||
|---|---|---|
| response | M | responseType |
| sendOrderRequestType | ||
|---|---|---|
| header
[?] order header data
|
M | header |
| lines
[?] order lines data
|
M , ∞ | lines |
| payment
[?] payment information
|
M | payment |
| header | ||
|---|---|---|
| orderNumber
[?] api will try to use given order number. if it fails or order number not given, api generates an order number
|
O | integer |
| accountInformation
[?] credentials of orderer
|
M | accountType |
| partyIdPartner
[?] id of partner that runs the partnershop, only if diffrent from orderer
|
O | integer |
| address
[?] address of orderer
|
M | AddressType |
| invoiceToContact
[?] address of invoice receiver if diffrent to orderer
|
O | longAddressType |
| environment
[?] portal / client data
|
M | environmentType |
| conversionRate
[?] exchange rate to euro if foreign currency used, else 1
|
M | float |
| currencyCode
[?] code of used currency
|
M | string |
| paymentMethodCode
[?] code of used payment method
|
M | string |
| lines | ||
|---|---|---|
| line
[?] position of a product or an independent addon (does not belong to any other position)
|
M | line |
| addons
[?] position/s of dependent addons (belong to position in this structure)
|
O , 99 | line |
| line | ||
|---|---|---|
| count
[?] number of this position in current order
|
O | int |
| lineType
[?] lineType = [ accessories_kit | additional shipping address | balance | crossselling discount | customer copy | DHL upgrade surcharge | different billing address | different shipping address | distribution costs | duty | EFS discount | foi surcharge | key account benefits | neutral shipping address | packing_subset | payment surcharge | payment target | PFE discount | picture_optimizing | position grouping | premium filecheck | premium filecheck inclusive | product | proof | screenproof | self_collection | special color surcharge | special distribution costs | special distribution costs flat | token discount ]
|
M | string |
| productData
[?] product information if lineType = [ product | proof | customer copy | screenproof ]
|
O | productData |
| addonData
[?] addon information if lineType = [ token discount | embossing_form | payment target ]
|
O | addonData |
| deliveryDate
[?] uncertain field function
|
O | date |
| deliveryDays
[?] uncertain field function
|
O | int |
| measureUnit
[?] measureUnit = [ kg | € | Sk | Ft | kr | Kc | £ | zl | PCS | PKG | PLT | CTN | mm | in | g | lb | oz | dr | gr | USD | CAD | s | mg | St | ml | PAC | ex | day | FCT | qmm | CUR | Dose | Rolle | BAG | CTNs | CTNl | CTNxl | Stück | Paar | Packu | Box | Kanis | Spule | Flasc | Kartu | Conta | Tube | m² | Set | Eimer | Fass | Paket | Sack | Boxen | Liter | Pack. | Block | bool | int | h | min | Karto | STK | BAGl ]
|
O | string |
| measureType
[?] measureType = [ weight | currency | packaging unit | item unit | proportions | time | calculation unit | various types | abstract type ]
|
O | string |
| quantity
[?] order quantity / amount
|
M | int |
| sellingPrice
[?] quantity >= 0 # net price of position
|
M | float |
| taxes
[?] tax information
|
M , ∞ | taxes |
| consignmentType
[?] uncertain field function
|
O | string |
| clearance
[?] clearance = [ 0 | 1 ] # delivery clearance
|
O | int |
| availabilityType
[?] availabilityType = [ standard | freedesign | javaFX ], default = standard
|
O | string |
| productInfo | ||
|---|---|---|
| itemGroupName | M | string |
| properties | M , ∞ | parameterType |
| variants | M , ∞ | variantType |
| tokenInfo | ||
|---|---|---|
| tokenName
[?] name of token action
|
M | string |
| tokenCode
[?] coupon code
|
M | string |
| tokenValueType
[?] token value type. Valid values are {fix|factor}
|
M | string |
| tokenValue
[?] original token value
|
M | int |
| addonData | ||
|---|---|---|
| productInfo
[?] item type description
|
O | productInfo |
| tokenInfo
[?] required information for token discount. appears if lineType = [ token discount ]
|
O | tokenInfo |
| balanceType
[?] appears if lineType = [ balance ]
|
O | string |
| paymentTargetDays
[?] appears if lineType = [ payment target ]
|
O | int |
| paymentTargetFeeType
[?] paymentTargetFeeType = [ FX | REL ] # appears if lineType = [ payment target ]
|
O | string |
| proofInformation | O | proofType |
| embossingOriginOrder
[?] appears if lineType = [ embossing_form ] and the origin ordernumber differs from current ordernumber. Format: "order_number-position"
|
O | string |
| taxes | ||
|---|---|---|
| countryCode
[?] country of tax. two character iso code
|
M | string |
| name
[?] taxName = [ Sales Tax | HST | PST | GST | RDE | Reduced Tax | Zero Tax | UST-ID ]
|
M | string |
| rate
[?] tax as multiplicator, e.g. 0.19 for 19 %
|
M | float |
| productData | ||
|---|---|---|
| orderName
[?] customer given name of product
|
O | string |
| customerComment
[?] further notice for product by customer
|
O | string |
| dataSourceInformation
[?] information where to find and how to access print data
|
M | dataSourceDataType |
| productInfo
[?] item type description
|
M | productInfo |
| shippingType
[?] shippingType = [ economy | standard | express| priority ]
|
M | string |
| shippingInformation
[?] detailed information about shipment
|
M | shippingDataType |
| productAlias
[?] product alias name
|
O | string |
| motiveBundleGroupNumber | O | int |
| specialDistributionCosts | O | float |
| payment | ||
|---|---|---|
| value
[?] paymentValue >= 0 #value of paid money
|
M | float |
| state
[?] state = [ STP | ABP ]
|
O | string |
| providerTransactionId
[?] the identifier set by provider for this payment, only present using online payment method such as Paypal, Debitcard or Saferpay
|
O | string |
| providerTransactionStatus
[?] The status of the payment returned by provider. Currently (2016-08-23) only in use with Paypal.
|
O | string |
| providerTransactionFee
[?] The fee of the payment returned by provider. Currently (2016-08-23) only in use with Paypal.
|
O | float |
| sendOrderResponseType | ||
|---|---|---|
| orderNumber
[?] if order commited sucessfully this field contains the number of the commited order.
|
O | int |
| errorMsg
[?] if order commit failed this field may contain description what went wrong
|
O | string |
| createOrderRequestType | ||
|---|---|---|
| environment
[?] portal / clinet data
|
M | environmentType |
| accountInformation
[?] A order request requires a login.
|
M | accountType |
| orderPositions
[?] All informations about the order positions.
Positions are limited to 99
|
O , 99 | orderPositionsTypes |
| orderAdditionals
[?] Use this structure for non product positions like price surcharges.
|
O | orderAdditionalType |
| paymentInformation
[?] Informatiosn about the payment modalities.
|
M | paymentDataType |
| validate
[?] If this value 1, the order was checked and created but not saved.
In this case the response contains the price and the estimated delivery date.
|
O | int |
| orderNumber
[?] ordernumber of the basket. if not given a ordernumber will be generated by target environment.
|
O | int |
| messageLevel
[?] Control the return message flow.
Possible values are: all|medium|silent
|
O | string |
| orderTypeId
[?]
A uniqe id to mark source of order creation
|
O | int |
| orderPositionsTypes | ||
|---|---|---|
| orderInformation
[?] all informatiosn about the ordered product
|
M | orderDataType |
| dataSourceInformation
[?]
contains a url and accessinformation
for the print data download
|
M | dataSourceDataType |
| shippingInformation
[?]
a order can have one or more shipments,
a shipment contains a address and the
quantity
|
M | shippingDataType |
| referenceId
[?] internal reference for assign a position to another position, only for the request
|
O | string |
| internalOrder
[?] xx
|
O | int |
| orderDataType | ||
|---|---|---|
| customerProductId
[?]
Identifier specified in the users
product list.
|
O | string |
| productDescription | O | productDescriptionType |
| orderQuantity
[?]
ordered quantity for produkt position.
Must be equal to the sum of all partial
quantities in the shipment address
structure.
|
M | int |
| aspectRatio
[?]
the page orientation. possible values
are: panel format|landscape
format|equilateral
|
O | string |
| shippingType
[?]
the order delivery type. possible values
are: economy|standard|express|priority
|
O | string |
| orderName
[?]
A name for your product. Ist only for
user.
|
O | string |
| rejectedOrder
[?]
A flag if the order is rejected by
partner shop.
|
O | int |
| customerCopy
[?]
send a count of customer copies from
product to the invoive address. possible
values are: 0|5|10|15
|
O | int |
| customerComment
[?]
A comment only for the user.
|
O | string |
| customerValues
[?]
Map of customer-defined values
|
O , ∞ | pairOfValueType |
| specialColorValues
[?]
A spcial color value. Contact
Unitedprint for details.
|
O , ∞ | pairOfValueType |
| specialFormatValues | O | specialFormatType |
| numberingValues | O | numberingValuesType |
| playerPrintValues | O | playerPrintValuesType |
| proof | O | proofType |
| priceGross
[?]
Set a special price for the product
position including tax. This feature
requires a spacial contract with
Unitedprint.
|
O | float |
| priceNet
[?]
Set a special price for the product
position without tax. This feature
requires a spacial contract with
Unitedprint.
|
O | float |
| created
[?]
Set a special value for the created
timestamp different from now. Not
supported for anyone.
|
O | dateTime |
| filecheck
[?]
Decribe the print data check (image) by
Unitedprint.Valid values are
{basis_file_check|premium_file_check}.
|
O | string |
| productAlias | O | string |
| vat0 | O | int |
| printdataStorage
[?]
customer wants to store printdata for this product permanently, this option is set as addon with costs during order
|
O | int |
| usePrintdataStorage
[?]
customer wants to use stored printdata, this option is set as addon during order without costs
the given value is the up-order_line_id of the original product
this addon can only occur on reprint-orders
|
O | int |
| motiveBundleGroupNumber | O | int |
| specialDistributionCosts | O | float |
| shippingDataType | ||
|---|---|---|
| deliveryType
[?]
Possible values are:
delivery|self_collect
|
M | string |
| shippingAddresses
[?]
One ore more (max 99) shipment
addresses.
|
O , 99 | orderAddressType |
| senderAddress
[?]
Use this address for neutral shipping.
|
O | shortAddressType |
| deliveryDays | O | int |
| noCollectedShipment
[?] No collection shipping. If not set suitable shipments are combined.
|
O | int |
| dataSourceDataType Define the data source. | ||
|---|---|---|
| dataSourceHost | M | string |
| dataSourcePort | M | string |
| dataSourceUser | M | string |
| dataSourcePassword | M | string |
| dataTransmission
[?] The way of data transmission.
Possible values are: upload|download|ftp|e-mail
For 'upload', 'ftp' and 'e-mail' you even sends the data to Unitedprint.
You get the access information to your account email address after the order request.
In case of 'download' Unitedprint use your data source informations to fetches the data.
|
M | string |
| orderAdditionalType | ||
|---|---|---|
| type
[?] Special type. Supported types are: DELIVERYCOSTSSPECFLAT|PICTUREOPT|DHLUPGRADESURCHARGE|BALANCE|AMAZONPRIME
|
M | string |
| text
[?] Text description
|
O | string |
| amount
[?] Additional with costs.
|
O | float |
| percent
[?] The amount is percentage to product price
|
O | float |
| referenceId
[?] Reference to a product position. Count starts on 1.
Use this for product dependet addionionals.
|
O | string |
| paymentDataType | ||
|---|---|---|
| paymentMethod
[?]
COD: cash on delivery COC: cash on
delivery - cheque BDD: bank direct debit
ADP: advance payment INV: invoice BTF:
bank transfer SCT: SEPA credit transfer
SDC: SEPA direct debit core SDB: SEPA
direct debit b2b
|
M | string |
| invoiceAddress
[?]
Receiver of invoice. Is not given, the
users profile address was used instead.
|
O | longAddressType |
| creditAmount
[?] use customer credit if available
|
O | float |
| couponCode
[?] use the coupon code to look for valid amount of credit
|
O | string |
| createOrderResponseType | ||
|---|---|---|
| environment | M | environmentType |
| response | M | responseType |
| productDescriptionType | ||
|---|---|---|
| itemGroup | M | int |
| properties | M , ∞ | parameterType |
| variants | M , ∞ | parameterType |
| proofType | ||
|---|---|---|
| envelopePages
[?] array of pages to proof
use contentPages for products without cover
|
O , ∞ | int |
| contentPages
[?] array of pages to proof
use contentPages for products without cover
|
O , ∞ | int |
| specialFormatType | ||
|---|---|---|
| width | M | int |
| height | M | int |
| formatType
[?] default is special format, optional is free_form
|
M | string |
| numberingValuesType | ||
|---|---|---|
| numberingStart
[?] Lowest and first value of numbering.
|
M | int |
| numberingEnd
[?] Highest and last value of numbering.
In case of a multi page product: pages * exemplares
|
M | int |
| numberingFont
[?] The font family name. Possible values are:
Arial|Helvetica|Verdana|Courier New|Times New Roman
|
O | string |
| playerPrintValuesType Player names and numbers on sport textile products | ||
|---|---|---|
| color
[?] Color of player numbers or names. Possible values are:
blue|light blue|red|black|white
|
M | string |
| player | M | playerPrintValuesPlayerType |
| playerPrintValuesPlayerType player numbers/names, the number of players must correspond to the ordered quantity | ||
|---|---|---|
| number
[?] player number
|
M | string |
| name
[?] player name (only if ordered)
|
O | string |
| createOrder | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||
| createServiceOrder | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||
| sendOrder | |||
|---|---|---|---|
| Input |
|
||
| Output |
|
||
| Fault | |||