eBay Merchant Data APIVersion 1255
 

OrderAckRequestType

Note: Large Merchant Services (LMS) functionality as a SOAP service has been decommissioned. It is fully migrated into the REST-based Sell Feed API The Sell Feed API supports the same XML data files that LMS supported but through REST methods. For more information, see the LMS Feed Guide. OrderAck is used to acknowledge that a single line item order, or an individual line item within a multiple line item order has been received. Once an order or order line item is successfully acknowledged with an OrderAck call, that order or order line item will not appear in the OrderReport response when you run either of those calls again.

Call that uses OrderAckRequestType:

Fields

OrderID ( string ) [0..1]
A unique identifier for an eBay order. An eBay order can contain one or more order line items. This field is used to acknowledge a single line item order. If the eBay order has multiple line items, an OrderAck call will be required to acknowledge each of those order line items, and the OrderLineItemID field must be used instead.

Typically, the OrderAck call will only be used on orders/line items that have already been paid for and shipped.

Note: In June 2019, eBay introduced a new order ID format, but allowed developers/sellers to decide whether to immediately adopt the new format, or to continue working with the old format. Users who wanted to adopt the new format, could either use a Trading WSDL Version 1113 (or newer), or they could even use an older Trading WSDL but set the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header value to 1113 in API calls. Beginning in June 2020, only the new order ID format will be returned in response payloads for paid orders, regardless of the WSDL version number or compatibility level.

Note that the unique identifier of a 'non-immediate payment' order will change as it goes from an unpaid order to a paid order. Due to this scenario, all calls that accept Order ID values as filters in the request payload, including the OrderAck call, will support the identifiers for both unpaid and paid orders. However, the OrderAck call is typically only used to acknowledge orders/line items that have already been paid for, so the new order ID format will be used for this call in most cases. The new order ID 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.

Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders or GetOrderTransactions call, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. Sellers should not fulfill orders until buyer has made payment.
See the Field Index to learn which calls use OrderID.

OrderLineItemID ( string ) [0..1]
A unique identifier for an order line item within an eBay order. An eBay order can contain one or more order line items. If you use this field, only the specified order line item will be acknowledged, and any additional order line items within the eBay order will remain unacknowledged.

If an order only has one order line item, either the OrderID or the OrderLineItemID field will acknowledge the entire order.
See the Field Index to learn which calls use OrderLineItemID.