NAME
Marketplace::Ebay::Order
DESCRIPTION
Class to handle the xml structures found in the GetOrders call.
http://developer.ebay.com/devzone/xml/docs/Reference/ebay/GetOrders.html
The aim is to have a consistent interface with Amazon::MWS::XML::Order so importing the orders can happens almost transparently.
ACCESSORS/METHODS
order
The raw structure got from the XML parsing
shop_type
Always returns ebay
name_from_shipping_address
By default, lookup the name from the shipping address. Defaults to true. Otherwise look it up from the first item. Prior to version 0.19, the name was looked up from the first item only.
order_number
read-write accessor for the (shop) order number so you can set this while importing it.
payment_status
read-write accessor for the payment status, so the shop can set it while importing it.
can_be_imported
Return true if both orderstatus and checkout status are completed
order_status
Return the order status and the payment status, separated by a colon.
ebay_order_number
Ebay order id.
remote_shop_order_id
Same as ebay_order_number
orderline
An arrayref with the TransactionArray.Transaction structure. This is used internally by items.
items
Return a list of Marketplace::Ebay::Order::Item objects.
order_date
Return a DateTime object with the creation time of the order.
The email of the buyer. Given that this is provided per item, the first one is used.
first_name
The first name of the buyer, looked up from the first item.
last_name
The last name of the buyer, looked up from the first item.
comments
The BuyerCheckoutMessage's field of the order.
shipping_method
The order's ShippingServiceSelected.ShippingService value
shipping_additional_costs
The order's ShippingServiceSelected.ShippingServiceAdditionalCost value. I.e., the cost of the shipping for the other items ordered.
shipping_first_unit
The order's ShippingServiceSelected.ShippingServiceCost value. This is the cost of the shipping for the first item.
shipping_cost
The total cost of the shipping. It is the shipping_first_unit + the additional costs multiplied by the number of additional items.
total_cost
The total of the order, as reported by Ebay.
subtotal
Sum of the subtotal of all items.
currency
The currency code of the order (looked up in the total).
payment_method
The CheckoutStatus.PaymentMethod value of the order.
order_is_shipped
Return true if all the items are marked as shipped.
ebay_site
Return the site where the order was placed. We have to loop over all the items and check if they match. If they don't, we throw an exception.
username
The ebay's username of the buyer.