Changes since
the last release

com.ebay.sdk.call
Class AddOrderCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.AddOrderCall

public class AddOrderCall
extends ApiCall

Wrapper class of the AddOrder call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: Order - The root container of the AddOrder request. In this call, the seller identifies two or more unpaid order line items from the same buyer through the TransactionArray container, specifies one or more accepted payment methods through the PaymentMethods field(s), and specifies available shipping services and other shipping details through the ShippingDetails container.
Output property: ReturnedOrderID - The unique identifier for the Combined Invoice order. This value is created by eBay upon a successful AddOrder call. This value can be used as an input filter in GetOrders and GetOrderTransactions to retrieve the order.
Output property: ReturnedCreatedTime - Timestamp that indicates the date and time that the Combined Invoice order was created.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
AddOrderCall()
          Constructor.
AddOrderCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 AddOrderResponseType addOrder()
          The AddOrder call can be used by a seller to combine two or more unpaid, single line item orders from the same buyer into one 'Combined Invoice' order with multiple line items.
 OrderType getOrder()
          Gets the AddOrderRequestType.order.
 Calendar getReturnedCreatedTime()
          Valid after executing the API.
 String getReturnedOrderID()
          Valid after executing the API.
 void setOrder(OrderType order)
          Sets the AddOrderRequestType.order.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AddOrderCall

public AddOrderCall()
Constructor.


AddOrderCall

public AddOrderCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

addOrder

public AddOrderResponseType addOrder()
                              throws ApiException,
                                     SdkException,
                                     Exception
The AddOrder call can be used by a seller to combine two or more unpaid, single line item orders from the same buyer into one 'Combined Invoice' order with multiple line items. Once multiple line items are combined into one order, the buyer can make one single payment for each line item in the order. If possible and agreed to, the seller can then ship multiple line items in the same shipping package, saving on shipping costs, and possibly passing that savings down to the buyer through Combined Shipping Discount rules set up in My eBay.

Returns:
The AddOrderResponseType object.
Throws:
ApiException
SdkException
Exception

getOrder

public OrderType getOrder()
Gets the AddOrderRequestType.order.

Returns:
OrderType

setOrder

public void setOrder(OrderType order)
Sets the AddOrderRequestType.order.

Parameters:
order - OrderType

getReturnedCreatedTime

public Calendar getReturnedCreatedTime()
Valid after executing the API. Gets the returned AddOrderResponseType.returnedCreatedTime.

Returns:
Calendar

getReturnedOrderID

public String getReturnedOrderID()
Valid after executing the API. Gets the returned AddOrderResponseType.returnedOrderID.

Returns:
String

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.