portal and client data
A order request requires a login.
Information about the payment modalities.
messageLevel = [ all | medium | silent ]
ordernumber of the service order of partnershop
rate of provision for that order that's produced by the partner as multiplicator, e.g. 0.2.
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.
The number of the position within the order.
consignmentType = [ EXP | OVN | STD | ECO ]
net price of product
view id to determine item group id
amount of ordered products
delivery date set by partnershop
days until delivery set by partnershop
customer comment
order header data
order lines data
payment information
api will try to use given order number. if it fails or order number not given, api generates an order number
credentials of orderer
id of partner that runs the partnershop, only if diffrent from orderer
address of orderer
address of invoice receiver if diffrent to orderer
portal / client data
exchange rate to euro if foreign currency used, else 1
code of used currency
code of used payment method
position of a product or an independent addon (does not belong to any other position)
position/s of dependent addons (belong to position in this structure)
number of this position in current order
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 ]
product information if lineType = [ product | proof | customer copy | screenproof ]
addon information if lineType = [ token discount | embossing_form | payment target ]
uncertain field function
uncertain field function
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 ]
measureType = [ weight | currency | packaging unit | item unit | proportions | time | calculation unit | various types | abstract type ]
order quantity / amount
quantity >= 0 # net price of position
tax information
uncertain field function
clearance = [ 0 | 1 ] # delivery clearance
availabilityType = [ standard | freedesign | javaFX ], default = standard
name of token action
coupon code
token value type. Valid values are {fix|factor}
original token value
item type description
required information for token discount. appears if lineType = [ token discount ]
appears if lineType = [ balance ]
appears if lineType = [ payment target ]
paymentTargetFeeType = [ FX | REL ] # appears if lineType = [ payment target ]
appears if lineType = [ embossing_form ] and the origin ordernumber differs from current ordernumber. Format: "order_number-position"
country of tax. two character iso code
taxName = [ Sales Tax | HST | PST | GST | RDE | Reduced Tax | Zero Tax | UST-ID ]
tax as multiplicator, e.g. 0.19 for 19 %
customer given name of product
further notice for product by customer
information where to find and how to access print data
item type description
shippingType = [ economy | standard | express| priority ]
detailed information about shipment
product alias name
paymentValue >= 0 #value of paid money
state = [ STP | ABP ]
the identifier set by provider for this payment, only present using online payment method such as Paypal, Debitcard or Saferpay
The status of the payment returned by provider. Currently (2016-08-23) only in use with Paypal.
The fee of the payment returned by provider. Currently (2016-08-23) only in use with Paypal.
if order commited sucessfully this field contains the number of the commited order.
if order commit failed this field may contain description what went wrong
portal / clinet data
A order request requires a login.
All informations about the order positions.
Positions are limited to 99
Use this structure for non product positions like price surcharges.
Informatiosn about the payment modalities.
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.
ordernumber of the basket. if not given a ordernumber will be generated by target environment.
Control the return message flow.
Possible values are: all|medium|silent
A uniqe id to mark source of order creation
all informatiosn about the ordered product
contains a url and accessinformation
for the print data download
a order can have one or more shipments,
a shipment contains a address and the
quantity
internal reference for assign a position to another position, only for the request
xx
Identifier specified in the users
product list.
ordered quantity for produkt position.
Must be equal to the sum of all partial
quantities in the shipment address
structure.
the page orientation. possible values
are: panel format|landscape
format|equilateral
the order delivery type. possible values
are: economy|standard|express|priority
A name for your product. Ist only for
user.
A flag if the order is rejected by
partner shop.
send a count of customer copies from
product to the invoive address. possible
values are: 0|5|10|15
A comment only for the user.
Map of customer-defined values
A spcial color value. Contact
Unitedprint for details.
Set a special price for the product
position including tax. This feature
requires a spacial contract with
Unitedprint.
Set a special price for the product
position without tax. This feature
requires a spacial contract with
Unitedprint.
Set a special value for the created
timestamp different from now. Not
supported for anyone.
Decribe the print data check (image) by
Unitedprint.Valid values are
{basis_file_check|premium_file_check}.
customer wants to store printdata for this product permanently, this option is set as addon with costs during order
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
Possible values are:
delivery|self_collect
One ore more (max 99) shipment
addresses.
Use this address for neutral shipping.
No collection shipping. If not set suitable shipments are combined.
Define the data source.
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.
Special type. Supported types are: DELIVERYCOSTSSPECFLAT|PICTUREOPT|DHLUPGRADESURCHARGE|BALANCE|AMAZONPRIME
Text description
Additional with costs.
The amount is percentage to product price
Reference to a product position. Count starts on 1.
Use this for product dependet addionionals.
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
Receiver of invoice. Is not given, the
users profile address was used instead.
use customer credit if available
use the coupon code to look for valid amount of credit
array of pages to proof
use contentPages for products without cover
array of pages to proof
use contentPages for products without cover
default is special format, optional is free_form
Lowest and first value of numbering.
Highest and last value of numbering.
In case of a multi page product: pages * exemplares
The font family name. Possible values are:
Arial|Helvetica|Verdana|Courier New|Times New Roman
Player names and numbers on sport textile products
Color of player numbers or names. Possible values are:
blue|light blue|red|black|white
player numbers/names, the number of players must correspond to the ordered quantity
player number
player name (only if ordered)