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 of the successfully-created 'Combined Invoice' order. This value is only created and returned if the AddOrder call is successful in creating the new order.

This value can be used as an input filter in GetOrders and GetOrderTransactions calls to retrieve the order.

Note: As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., OrderID or OrderLineItemID), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.

During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header in API calls to control whether the new or old OrderID format is returned in call response payloads. To get the new OrderID format, the value of the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header must be set to 1113. During the transition period and even after, the new and old OrderID formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.

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.
 java.util.Calendar getReturnedCreatedTime()
          Valid after executing the API.
 java.lang.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, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, 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,
                                     java.lang.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 multiple line item 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
java.lang.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 java.util.Calendar getReturnedCreatedTime()
Valid after executing the API. Gets the returned AddOrderResponseType.returnedCreatedTime.

Returns:
Calendar

getReturnedOrderID

public java.lang.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.