SetShipmentTrackingInfo

Includes information about a specific item and the shipping information associated with it.

SetShipmentTrackingInfo 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).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<SetShipmentTrackingInfoResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- 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 here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <!-- Call-specific Output Fields -->
  <OrderLineItemID> string </OrderLineItemID>
</SetShipmentTrackingInfoResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific 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 (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) 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 (out) Reserved for internal or future use. • RequestError (out) 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 (out) 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 (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.

Call-specific Output 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.

SetShipmentTrackingInfo Samples

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

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Request that you use to record that an order has been shipped. Use the SetShipmentTrackingInfo request to associate each line item in a SoldReport to the shipped time, tracking service, and tracking number that you used when shipping an item.

Description

User megaonlinemerchant wants to keep track of the carrier information and tracking number for each item in her Sold Report that she has shipped to date. She starts order processing and creates a data file to set the shipment tracking info. at the same time she creates the data file to acknowledged orders in her Sold Report.

Input

The fields in the following SetShipmentTrackingInfo request represent a shipped item from one of megaonlinemerchant's basketball shoe listings. In this sample, we have included a basic SetShipmentTrackingInfo request. In a more typical SetShipmentTrackingInfo request file, you might record and upload data for thousands of shipped 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>
  <SetShipmentTrackingInfoRequest xmlns="urn:ebay:apis:eBLBaseComponents">
    <OrderID>110035505229-23336925001</OrderID>
    <OrderLineItemID>110035505229-23336925001</OrderLineItemID>
    <Shipment> 
      <ShipmentTrackingNumber>1Z 999 999 99 9999 999 9</ShipmentTrackingNumber>
      <ShippedTime>2008-11-25T12:00:00.000Z</ShippedTime>
      <ShippingCarrierUsed>UPS</ShippingCarrierUsed>
    </Shipment>
  </SetShipmentTrackingInfoRequest>
  <SetShipmentTrackingInfoRequest xmlns="urn:ebay:apis:eBLBaseComponents">
    <OrderID>110035571629-23291233001</OrderID>
    <OrderLineItemID>110035571629-23291233001</OrderLineItemID>
    <Shipment> 
      <ShipmentTrackingNumber>1Z 888 888 88 8888 888 8</ShipmentTrackingNumber>
      <ShippedTime>2008-11-25T12:00:00.000Z</ShippedTime>
      <ShippingCarrierUsed>UPS</ShippingCarrierUsed>
    </Shipment>
  </SetShipmentTrackingInfoRequest>
  <SetShipmentTrackingInfoRequest xmlns="urn:ebay:apis:eBLBaseComponents">
    <OrderID>110035504829-23270675001</OrderID>
    <OrderLineItemID>110035504829-23270675001</OrderLineItemID>
    <Shipment> 
      <ShipmentTrackingNumber>1Z 777 777 77 7777 777 7</ShipmentTrackingNumber>
      <ShippedTime>2008-11-25T12:00:00.000Z</ShippedTime>
      <ShippingCarrierUsed>UPS</ShippingCarrierUsed>
    </Shipment>
  </SetShipmentTrackingInfoRequest>
</BulkDataExchangeRequests>

Output

The SetShipmentTrackingInfo response file includes the OrderID and OrderLineItemID of the item you have shipped, call Success or Failure, and any error numbers and messages returned by the call request. For multiple line items, each shipment is listed as a separate node.

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

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

SetShipmentTrackingInfo Change History

Version	Description
589 2008-11-29	(added) New call.

This document was generated with a customized version of the apireferencedocs tool.

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 within an order.
Shipment	ShipmentType	Required	Includes carrier name, tracking number, and shipped time.
Shipment .ShipmentTrackingDetails	ShipmentTrackingDetailsType	Required, repeatable: [1..*]	Container for the shipping carrier and tracking information associated with an item shipment. This is a repeatable container, allowing for multiple package shipments to be input for a single item transaction.
Shipment .ShipmentTrackingDetails .ShipmentTrackingNumber	string	Required	The tracking number assigned by the shipping carrier to the item shipment. The format of the tracking number must be consistent with the format used by the specified shipping carrier (ShippingCarrierUsed).
Shipment .ShipmentTrackingDetails .ShippingCarrierUsed	string	Required	Name of the shipping carrier used to ship the item.
Shipment.ShippedTime	dateTime	Required	The time that the seller handed off the item to the shipping carrier.

eBay Merchant Data API API Reference Version 643

eBay Merchant Data API
API Reference Version 643