OrderAck

Request that you use to acknowlege that an order has been received. Use the OrderAck job to acknowledge each line item in a SoldReport by order or line item. After you send the first OrderAck call, future SoldReports will only contain unacknowledged orders or line items.

Note: OrderAck cannot be issued on its own like an ordinary API call, using an endpoint. This Large Merchant Services call must be entered one or more times as the payload in a data file that will be uploaded to an eBay server using the File Transfer API, then processed using the Bulk Data Exchange API. This call will fail if you attempt to invoke it directly.

OrderAck Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

OrderAck Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<OrderAckResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <OrderLineItemID> string </OrderLineItemID>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
</OrderAckResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

OrderLineItemID

string

Always

OrderLineItemID is required upon input and always returned in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests.

Standard Output Fields

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode Reserved for internal or future use. • Failure Request processing failed • Success Request processing succeeded • Warning Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode Reserved for internal or future use. • RequestError An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode Reserved for internal or future use • Error Application-level error • Warning Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.

OrderAck Samples

New to making API calls? Please see Making an API Call.

Note: Some data in these samples might no longer be active. If necessary, you can substitute current data in your requests.

Available samples:

Acknowledging Single Line Item Orders ↓ - This call is used to acknowledge that orders have been received. The OrderID and OrderLineItemID values are passed in for each order line item. For single line item orders, these two values are the same. All orders that are acknowledged through the OrderAck call will no longer appear in the SoldReport responses.
Acknowledging Single and Multiple Line Item Orders ↓ - This call is used to acknowledge that orders have been received. The OrderID and OrderLineItemID values are passed in for each order line item. For single line item orders, these two values are the same. For multiple line item orders, the OrderID value is the Combined Payment order ID that is automatically generated by eBay when multiple order line items are combined into one order and the buyer makes one payment for multiple order line items. All orders that are acknowledged through the OrderAck call will no longer appear in any SoldReport responses.

Sample: Acknowledging Single Line Item Orders

This call is used to acknowledge that orders have been received. The OrderID and OrderLineItemID values are passed in for each order line item. For single line item orders, these two values are the same. All orders that are acknowledged through the OrderAck call will no longer appear in the SoldReport responses.

Description

User megaonlinemerchant wants to send an order acknowledgement for three single line item orders that appeared in the SoldReport reponse, so that they will not appear in a subsequent SoldReport response.

Input

In this OrderAck sample, megaonlinemerchant's is acknowledging three single line item orders. Since the orders are all single line item orders, the OrderID and OrderLineItemID values are the same. An OrderAckRequest node is required for each order line item. Although this sample covers only three orders, it is not uncommon that an OrderAck call is used to acknowledge thousands of order line items. In a more typical OrderAck request file, a seller might acknowledge thousands of sold items.

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<BulkDataExchangeRequests>
  <Header>
    <Version>591</Version>
    <SiteID>0</SiteID>
  </Header>
  <OrderAckRequest xmlns="urn:ebay:apis:eBLBaseComponents">
    <OrderID>110035505229-23336925001</OrderID>
    <OrderLineItemID>110035505229-23336925001</OrderLineItemID>
  </OrderAckRequest>
  <OrderAckRequest xmlns="urn:ebay:apis:eBLBaseComponents">
    <OrderID>110035571629-23291233001</OrderID>
    <OrderLineItemID>110035571629-23291233001</OrderLineItemID>
  </OrderAckRequest>
  <OrderAckRequest xmlns="urn:ebay:apis:eBLBaseComponents">
    <OrderID>110035504829-23270675001</OrderID>
    <OrderLineItemID>110035504829-23270675001</OrderLineItemID>
  </OrderAckRequest>
</BulkDataExchangeRequests>

Output

The OrderAck response file includes an OrderAckResponse node for each order line item that megaonlinemerchant's is attempting to acknowledge. Each OrderAckResponse node includes the unique identifier of the order line item (OrderLineItemID) and an ack value of 'Success' or 'Failure'. In this sample, all three single line item orders were acknowledged successfully, and these order line items will no longer appear in a SoldReport response. If any errors or warnings occured at the call level, they would have been emitted in the response through an Errors container.

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<BulkDataExchangeResponses xmlns="urn:ebay:apis:eBLBaseComponents">
  <OrderAckResponse>
    <Ack>Success</Ack>
    <OrderLineItemID>110035505229-23336925001</OrderLineItemID>
  </OrderAckResponse>
  <OrderAckResponse>
    <Ack>Success</Ack>
    <OrderLineItemID>110035571629-23291233001</OrderLineItemID>
  </OrderAckResponse>
  <OrderAckResponse>
    <Ack>Success</Ack>
    <OrderLineItemID>110035504829-23270675001</OrderLineItemID>
  </OrderAckResponse>
</BulkDataExchangeResponses>

Back to list of samples

Sample: Acknowledging Single and Multiple Line Item Orders

This call is used to acknowledge that orders have been received. The OrderID and OrderLineItemID values are passed in for each order line item. For single line item orders, these two values are the same. For multiple line item orders, the OrderID value is the Combined Payment order ID that is automatically generated by eBay when multiple order line items are combined into one order and the buyer makes one payment for multiple order line items. All orders that are acknowledged through the OrderAck call will no longer appear in any SoldReport responses.

Description

User megaonlinemerchant wants to send an order acknowledgement for two orders. One order is a single line item order, and the other order contains two order line items. Once these three order line items are acknowledged through this OrderAck call, they will no longer appear in any SoldReport responses.

Input

In this OrderAck sample, megaonlinemerchant's is acknowledging three order line items that are a part of two separate orders. The first order line item in the request, 110035505229-23336925001, makes up a single line item order, so the OrderID and OrderLineItemID values are the same. The order line items identified as 150004254168-7932295005 and 150004254165-7932296005 are two order line items that are a part of the same Combined Payment order, so a separate, unique OrderID value was created by eBay as soon as these items became part of a Combined Payment order. An OrderAckRequest node is required for each order line item. Notice that the second and third order line items passed in the request have the same Combined Payment OrderID value.

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<BulkDataExchangeRequests>
  <Header>
    <Version>819</Version>
    <SiteID>0</SiteID>
  </Header>
  <OrderAckRequest xmlns="urn:ebay:apis:eBLBaseComponents">
    <OrderID>110035505229-23336925001</OrderID>
    <OrderLineItemID>110035505229-23336925001</OrderLineItemID>
  </OrderAckRequest>
  <OrderAckRequest xmlns="urn:ebay:apis:eBLBaseComponents">
    <OrderID>6082929012</OrderID>
    <OrderLineItemID>150004254168-7932295005</OrderLineItemID>
  </OrderAckRequest>
  <OrderAckRequest xmlns="urn:ebay:apis:eBLBaseComponents">
    <OrderID>6082929012</OrderID>
    <OrderLineItemID>150004254165-7932296005</OrderLineItemID>
  </OrderAckRequest>
</BulkDataExchangeRequests>

Output

The OrderAck response file includes an OrderAckResponse node for each order line item that megaonlinemerchant's is attempting to acknowledge. Each OrderAckResponse node includes the unique identifier of the order line item (OrderLineItemID) and an ack value of 'Success' or 'Failure'. In this sample, all three order line items (two of which were part of the same Combined Payment order) were acknowledged successfully, and these order line items will no longer appear in a SoldReport response. If any errors or warnings occured at the call level, they would have been emitted in the response through an Errors container.

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<BulkDataExchangeResponses xmlns="urn:ebay:apis:eBLBaseComponents">
  <OrderAckResponse>
    <Ack>Success</Ack>
    <OrderLineItemID>110035505229-23336925001</OrderLineItemID>
  </OrderAckResponse>
  <OrderAckResponse>
    <Ack>Success</Ack>
    <OrderLineItemID>150004254168-7932295005</OrderLineItemID>
  </OrderAckResponse>
  <OrderAckResponse>
    <Ack>Success</Ack>
    <OrderLineItemID>150004254165-7932296005</OrderLineItemID>
  </OrderAckResponse>
</BulkDataExchangeResponses>

Back to list of samples

OrderAck Change History

Version	Description
821 2013-04-24	(doc change) Added a new sample to demonstrate how to acknowledge multiple line item orders.
589 2008-11-29	(added) New call.

User-Contributed Notes

OrderID	string	Required	An ID that uniquely identifies each order (item or items paid for within the same transaction).
OrderLineItemID	string	Required	An ID that uniquely identifies each line item (specifics about a purchased item or SKU) within an order.