a single return value of a getInfo() call.
the path will be always returned.
the error element will be returned in case of error.
all other elements will be returned if no error has occured.
order document object path
order document alias
path to order document's class
order document's order (object path to order)
document issued or not
order document's issue date
the products, payments, shipping etc. of this order document (see orderdocumenttypes:TLineItemContainerOut)
list of requested attributes (see epagestypes:ListOfAttributes)
error object (see epagestypes:TError)
a single return value of an exists() call.
the path will be always returned.
the error element will be returned in case of error.
the exists flag will be returned if no error has occured.
a boolean flag indicating whether or not this order document exists
error object (see epagestypes:TError)
a single return value of a delete() call.
the path will be always returned.
the error element will be returned in case of error.
the deleted flag will be returned if no error has occured.
a boolean flag indicating whether or not this order document has been deleted
error object (see epagestypes:TError)
input arguments of a create() call.
a set of order document specific attributes that will be used to create an order document.
the alias element is optional, a new alias will be created if omitted.
all others are optional.
order alias
order document's order (object path to order)
order document's class (object path to order document class)
indicates whether or not the order document has been issued
order document's issue date. will be ignored if Issued indicates false. if Issued indicates true and IssueDate is omitted the current date will be used.
a single return value of a create() call.
Alias, Class, and Order will be always returned.
the error element will be returned in case of error.
the created flag and path will be returned if no error has occured.
a boolean flag indicating that this order document was created
error object (see epagestypes:TError)
input arguments of a single update() order call.
a set of optional order specific attributes that will be updated.
the path element is mandatory.
all others are optional.
order document object path
update order document (see ordertypes:TLineItemContainerIn)
list of to update additional attributes (see epagestypes:ListOfAttributes)
a single return value of a update() order call.
the path will be always returned.
the error element will be returned in case of error.
the updated flag will be returned if no error has occured.
a boolean flag indicating that this order was updated
error object (see epagestypes:TError)
a single return value of a getInvoices() call.
The Order will be always returned.
The error element will be returned in case of error.
The Invoices element will be returned if no error occured.
paths of all invoices of the order
error object (see epagestypes:TError)
a single return value of a getPackingSlips() call.
The Order will be always returned.
The error element will be returned in case of error.
The PackingSlips element will be returned if no error occured.
paths of all packing slips of the order
error object (see epagestypes:TError)
a single return value of a getCreditNotes() call.
The Order will be always returned.
The error element will be returned in case of error.
The CreditNotes element will be returned if no error occured.
paths of all credit notes of the order
error object (see epagestypes:TError)
A list of object paths.
return object of an line item container.
contains information about products, payments, shippings etc. of this order.
the locale id of the container (e.g. 'en_US')
the language of the container
the currency of the container (e.g. 'EUR' or 'USD')
the tax area of the container (path to tax area object)
the name of the tax area of the container
the tax model of the container (net or gross)
the total price of the container
the total price of the container (without tax)
the total tax of the container
the container's product line items
the container's tax line items
the container's payment line item
the container's shipping line item
the container's coupon line items
the container's shipping option line items
the container's basket discount line items
input object of an line item container.
contains information about products, payments, shippings etc. of this order.
tax area, product line items, payment and shipping are mandatory.
all others are optional.
the locale id of the container (e.g. 'en_US')
the language of the container
the currency of the container (e.g. 'EUR' or 'USD')
the tax area of the container (path to tax area object)
the tax model of the container (net or gross)
the container's product line items
the container's payment method (object path to payment method)
the container's shipping method (object path to shipping method)
list of product line items.
see ordertypes:TProductLineItemOut
input object of an product line item.
contains information about a single product of this order.
product path is mandatory, the quantity is optional (1 is default).
the product object path of the product line item
quantity of the product line item
list of tax line items.
see ordertypes:TTaxLineItem
list of coupon line items.
see ordertypes:TCouponLineItem
list of shipping option line items.
see ordertypes:TShippingOptionLineItem
list of basket dicount line items.
see ordertypes:TGlobalValueDiscountLineItem
return object of an product line item.
contains information about a single product of this order.
the class of the product line item
name of the product line item
sku of the product line item
the product object path of the product line item
the tax class of the product line item (object path to tax class)
the total price of the product line item
the price a single product
quantity of the product line item
possible discount of the product line item
the tax rate of the product line item
the tax amount of the product line item
list of requested attributes (see epagestypes:ListOfAttributes)
return object of an shipping line item.
contains information about a the shipping of this order.
the class of the shipping line item
name of the shipping line item
sku of the shipping line item
the shipping method of the shipping line item (object path to shipping method)
the tax class of the shipping line item (object path to tax class)
the total price of the shipping line item
the baseprice of the shipping line item
quantity of the shipping line item
possible discount of the shipping line item
the tax rate of the shipping line item
the tax amount of the shipping line item
list of requested attributes (see epagestypes:ListOfAttributes)
return object of an payment line item.
contains information about a the payment of this order.
the class of the payment line item
name of the payment line item
sku of the payment line item
the payment method of the payment line item (object path to payment method)
the payment type of the payment line item (object path to payment type)
the tax class of the payment line item (object path to tax class)
the total price of the payment line item
the baseprice of the payment line item
quantity of the payment line item
possible discount of the payment line item
the tax rate of the payment line item
the tax amount of the payment line item
list of requested attributes (see epagestypes:ListOfAttributes)
return object of an tax line item.
contains information about a single tax class of this order.
the class of the tax line item
name of the tax line item
sku of the tax line item
the tax area of the tax line item (object path to tax area)
the tax matrix of the tax line item (object path to tax matrix)
the tax class of the tax line item (object path to tax class)
the total price of the tax line item
the baseprice of the tax line item
quantity of the tax line item
possible discount of the tax line item
the tax rate of the tax line item
the tax amount of the tax line item
list of requested attributes (see epagestypes:ListOfAttributes)
return object of an coupon line item.
contains information about a the coupon of this order.
the class of the coupon line item
name of the coupon line item
sku of the coupon line item (couponcode short)
the tax class of the coupon line item (object path to tax class)
quantity of the coupon line item
the baseprice of the coupon line item
the total price of the coupon line item
possible discount of the coupon line item
the tax rate of the coupon line item
the tax amount of the coupon line item
list of requested attributes (see epagestypes:ListOfAttributes)
the CouponCode (path) of the coupon line item
return object of an shipping option line item.
contains information about a the shipping option of this order.
the class of the shipping option line item
name of the shipping option line item
sku of the shipping option line item (couponcode short)
the tax class of the shipping option line item (object path to tax class)
quantity of the shipping option line item
the baseprice of the shipping option line item
the total price of the shipping option line item
possible discount of the shipping option line item
the tax rate of the coupon line item
the tax amount of the shipping option line item
list of requested attributes (see epagestypes:ListOfAttributes)
the Choice (path) of the shipping option line item
the Choice (name) of the shipping option line item
the Comment of the shipping option line item
return object of an basket dicount line item.
contains information about a the basket discount of this order.
the class of the basket discount line item
name of the basket discountn line item
sku of the basket discount line item (couponcode short)
the tax class of the basket discount line item (object path to tax class)
quantity of the basket discount line item
the baseprice of the basket discount line item
the total price of the basket discount line item
possible discount of the basket discount line item
the tax rate of the basket discount line item
the tax amount of the basket discount line item
list of requested attributes (see epagestypes:ListOfAttributes)