eBay Merchant Data APIVersion 1255
 

SetShipmentTrackingInfoRequestType

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. Specifies the shipment tracking information associated with one package of an order. If multiple packages are required for the order, this call must be made separately for each package.

Call that uses SetShipmentTrackingInfoRequestType:

Fields



IsPaid ( boolean ) [0..1]
This field is included and set to true to indicate that the buyer has paid for the order.
See the Field Index to learn which calls use IsPaid.

IsShipped ( boolean ) [0..1]
This field is included and set to true to indicate that an order or order line item was shipped. If this element is missing, eBay assumes that the order or order line item was shipped.
See the Field Index to learn which calls use IsShipped.

OrderID ( string ) [0..1]
A unique identifier that identifies a single line item or multiple line item order. Either the OrderID or OrderLineItemID value must be passed in the request.

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 SetShipmentTrackingInfo call, will support the identifiers for both unpaid and paid orders. However, the SetShipmentTrackingInfo call is typically only used to provide shipment tracking information for 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 eBay order line item. This identifier is created as soon as there is a commitment to buy from the seller. Either the OrderLineItemID or the OrderID value must be passed in the request.
See the Field Index to learn which calls use OrderLineItemID.

Shipment ( ShipmentType ) [0..1]
This container is used to provide the name of the shipping carrier, the package tracking number, and optionally, the timestamp of the shipment.
See the Field Index to learn which calls use Shipment.