Merchant Data API871

SetShipmentTrackingInfo

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.

Note: For orders on the eBay India site, SetShipmentTrackingInfo cannot be used if the buyer uses PaisaPay as the payment method. Note: SetShipmentTrackingInfo 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.

In the Trading API, the CompleteSale call provides similar functionality that you can invoke directly. For more information, see the CompletSale call reference.



Back to top

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.

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

<?xml version="1.0" encoding="utf-8"?>
<SetShipmentTrackingInfoRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <IsPaid> boolean </IsPaid>
  <IsShipped> boolean </IsShipped>
  <OrderID> string </OrderID>
  <OrderLineItemID> string </OrderLineItemID>
  <Shipment> ShipmentType
    <DeliveryDate> dateTime </DeliveryDate>
    <DeliveryStatus> ShipmentDeliveryStatusCodeType </DeliveryStatus>
    <EstimatedDeliveryDate> dateTime </EstimatedDeliveryDate>
    <InsuredValue> AmountType (double) </InsuredValue>
    <ItemTransactionID> ItemTransactionIDType
      <ItemID> ItemIDType (string) </ItemID>
      <OrderLineItemID> string </OrderLineItemID>
      <SKU> SKUType (string) </SKU>
      <TransactionID> string </TransactionID>
    </ItemTransactionID>
    <Notes> string </Notes>
    <PackageDepth> MeasureType (decimal) </PackageDepth>
    <PackageLength> MeasureType (decimal) </PackageLength>
    <PackageWidth> MeasureType (decimal) </PackageWidth>
    <PayPalShipmentID> string </PayPalShipmentID>
    <PostageTotal> AmountType (double) </PostageTotal>
    <PrintedTime> dateTime </PrintedTime>
    <RefundGrantedTime> dateTime </RefundGrantedTime>
    <RefundRequestedTime> dateTime </RefundRequestedTime>
    <ShipFromAddress> AddressType
      <AddressID> string </AddressID>
      <AddressOwner> AddressOwnerCodeType </AddressOwner>
      <AddressRecordType> AddressRecordTypeCodeType </AddressRecordType>
      <AddressStatus> AddressStatusCodeType </AddressStatus>
      <AddressUsage> AddressUsageCodeType </AddressUsage>
      <CityName> string </CityName>
      <CompanyName> string </CompanyName>
      <Country> CountryCodeType </Country>
      <CountryName> string </CountryName>
      <County> string </County>
      <ExternalAddressID> string </ExternalAddressID>
      <FirstName> string </FirstName>
      <InternationalName> string </InternationalName>
      <InternationalStateAndCity> string </InternationalStateAndCity>
      <InternationalStreet> string </InternationalStreet>
      <LastName> string </LastName>
      <Name> string </Name>
      <Phone> string </Phone>
      <Phone2> string </Phone2>
      <Phone2AreaOrCityCode> string </Phone2AreaOrCityCode>
      <Phone2CountryCode> CountryCodeType </Phone2CountryCode>
      <Phone2CountryPrefix> string </Phone2CountryPrefix>
      <Phone2LocalNumber> string </Phone2LocalNumber>
      <PhoneAreaOrCityCode> string </PhoneAreaOrCityCode>
      <PhoneCountryCode> CountryCodeType </PhoneCountryCode>
      <PhoneCountryPrefix> string </PhoneCountryPrefix>
      <PhoneLocalNumber> string </PhoneLocalNumber>
      <PostalCode> string </PostalCode>
      <ReferenceID> string </ReferenceID>
      <StateOrProvince> string </StateOrProvince>
      <Street> string </Street>
      <Street1> string </Street1>
      <Street2> string </Street2>
    </ShipFromAddress>
    <ShipmentID> long </ShipmentID>
    <ShipmentLineItem> ShipmentLineItemType
      <LineItem> LineItemType
        <CountryOfOrigin> string </CountryOfOrigin>
        <Description> string </Description>
        <ItemID> ItemIDType (string) </ItemID>
        <Quantity> int </Quantity>
        <TransactionID> string </TransactionID>
      </LineItem>
      <!-- ... more LineItem nodes allowed here ... -->
    </ShipmentLineItem>
    <ShipmentTrackingDetails> ShipmentTrackingDetailsType
      <ShipmentLineItem> ShipmentLineItemType
        <LineItem> LineItemType
          <CountryOfOrigin> string </CountryOfOrigin>
          <Description> string </Description>
          <ItemID> ItemIDType (string) </ItemID>
          <Quantity> int </Quantity>
          <TransactionID> string </TransactionID>
        </LineItem>
        <!-- ... more LineItem nodes allowed here ... -->
      </ShipmentLineItem>
      <ShipmentTrackingNumber> string </ShipmentTrackingNumber>
      <ShippingCarrierUsed> string </ShippingCarrierUsed>
    </ShipmentTrackingDetails>
    <!-- ... more ShipmentTrackingDetails nodes allowed here ... -->
    <ShipmentTrackingNumber> string </ShipmentTrackingNumber>
    <ShippedTime> dateTime </ShippedTime>
    <ShippingAddress> AddressType
      <AddressID> string </AddressID>
      <AddressOwner> AddressOwnerCodeType </AddressOwner>
      <AddressRecordType> AddressRecordTypeCodeType </AddressRecordType>
      <AddressStatus> AddressStatusCodeType </AddressStatus>
      <AddressUsage> AddressUsageCodeType </AddressUsage>
      <CityName> string </CityName>
      <CompanyName> string </CompanyName>
      <Country> CountryCodeType </Country>
      <CountryName> string </CountryName>
      <County> string </County>
      <ExternalAddressID> string </ExternalAddressID>
      <FirstName> string </FirstName>
      <InternationalName> string </InternationalName>
      <InternationalStateAndCity> string </InternationalStateAndCity>
      <InternationalStreet> string </InternationalStreet>
      <LastName> string </LastName>
      <Name> string </Name>
      <Phone> string </Phone>
      <Phone2> string </Phone2>
      <Phone2AreaOrCityCode> string </Phone2AreaOrCityCode>
      <Phone2CountryCode> CountryCodeType </Phone2CountryCode>
      <Phone2CountryPrefix> string </Phone2CountryPrefix>
      <Phone2LocalNumber> string </Phone2LocalNumber>
      <PhoneAreaOrCityCode> string </PhoneAreaOrCityCode>
      <PhoneCountryCode> CountryCodeType </PhoneCountryCode>
      <PhoneCountryPrefix> string </PhoneCountryPrefix>
      <PhoneLocalNumber> string </PhoneLocalNumber>
      <PostalCode> string </PostalCode>
      <ReferenceID> string </ReferenceID>
      <StateOrProvince> string </StateOrProvince>
      <Street> string </Street>
      <Street1> string </Street1>
      <Street2> string </Street2>
    </ShippingAddress>
    <ShippingCarrierUsed> string </ShippingCarrierUsed>
    <ShippingFeature> ShippingFeatureCodeType </ShippingFeature>
    <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
    <ShippingServiceUsed> token </ShippingServiceUsed>
    <Status> ShipmentStatusCodeType </Status>
    <WeightMajor> MeasureType (decimal) </WeightMajor>
    <WeightMinor> MeasureType (decimal) </WeightMinor>
  </Shipment>
</SetShipmentTrackingInfoRequest>
Argument Type Occurrence Meaning
IsPaid boolean --- The seller includes and sets this field to true if the buyer has paid for the order. If the call is successful, the order line item(s) are marked as Paid in My eBay.

If the seller includes and sets this field to false, the order line item(s) are marked (or remain) as Not Paid in My eBay.

If this field is not included, the paid status of the order line item(s) remain unchanged in My eBay.
IsShipped boolean --- When shipment tracking information is provided through the Shipment container in the same request, the IsShipped status is set to true automatically. If the call is successful, the specified order or order line item(s) are marked as Shipped in My eBay.

If the seller includes and sets this field to false, the order or order line item(s) are marked (or remain) as Not Shipped in My eBay.
OrderID string --- A unique identifier that identifies a single line item or multiple line item (Combined Payment) order.

For a single line item order, the OrderID value is identical to the OrderLineItemID value that is generated upon creation of the order line item. For a Combined Payment order, the OrderID value is created by eBay when the buyer or seller (sharing multiple, common order line items) combines multiple order line items into a Combined Payment order through the eBay site. A Combined Payment order can also be created by the seller through the AddOrder call. Either the OrderID or the OrderLineItemID value must be passed in the request.
OrderLineItemID string --- A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. Either the OrderLineItemID or the OrderID value must be passed in the request.
Shipment ShipmentType --- Container consisting of the shipping carrier name, the package tracking number, and optionally, the timestamp of the shipment.
Shipment.DeliveryDate dateTime --- Revise only
Shipment.DeliveryStatus ShipmentDeliveryStatusCodeType --- Revise only
Shipment.EstimatedDeliveryDate dateTime ---
Shipment.InsuredValue AmountType (double) ---
Shipment.ItemTransactionID ItemTransactionIDType ---
Shipment.ItemTransactionID
  .ItemID
ItemIDType (string) --- Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), but only one ItemID. Unless an OrderLineItemID or SKU value is specified in the same node, this field is required for each ItemTransactionID node included in the request.
Shipment.ItemTransactionID
  .OrderLineItemID
string --- OrderLineItemID is a unique identifier for an eBay order line item and is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. If an OrderLineItemID is included in a ItemTransactionID node in the request, the ItemID, TransactionID, and SKU fields are not required and are ignored if they are included in the request.
Shipment.ItemTransactionID.SKU SKUType (string) --- A SKU (stock keeping unit) is a unique identifier defined and used by the seller to identify a product or variation of an item. A listing can have multiple SKUs and it is possible that the same SKU can exist in multiple listings. Unless an OrderLineItemID or ItemID/TransactionID pair is specified in the same node, this field is required for each ItemTransactionID node included in the request. To retrieve order line items associated with a SKU, the InventoryTrackingMethod field must be set to SKU. The InventoryTrackingMethod field is set through AddFixedPriceItem or RelistFixedPriceItem.
Shipment.ItemTransactionID
  .TransactionID
string --- Unique identifier for an eBay order line item (transaction). The TransactionID should match the ItemID specified in each ItemTransactionID node included in the request. Optionally, an OrderLineItemID value can substitute for the ItemID/TransactionID pair.
Shipment.Notes string --- This string field allows a seller to provide notes to the buyer regarding shipment of a Half.com item. Only alphanumeric characters can be used in this field. This is an optional field that is only applicable to Half.com items.
Shipment.PackageDepth MeasureType (decimal) --- Depth dimension of the package needed to ship the item after it is sold.
For calculated shipping only.
Shipment.PackageLength MeasureType (decimal) --- Length dimension of the package needed to ship the item after it is sold.
For calculated shipping only.
Shipment.PackageWidth MeasureType (decimal) --- Width dimension of the package needed to ship the item after it is sold.
For calculated shipping only.
Shipment.PayPalShipmentID string ---
Shipment.PostageTotal AmountType (double) ---
Shipment.PrintedTime dateTime ---
Shipment.RefundGrantedTime dateTime --- Revise only
Shipment.RefundRequestedTime dateTime --- Revise only
Shipment.ShipFromAddress AddressType --- The address from which the item is being shipped.
Shipment.ShipFromAddress
  .AddressID
string --- Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address.
Shipment.ShipFromAddress
  .AddressOwner
AddressOwnerCodeType --- The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com.

Applicable values:

•   CustomCode

Reserved for internal or future use.

•   eBay

This value indicates that the shipping address being referenced is on file with eBay.

•   PayPal

This value indicates that the shipping address being referenced is on file with PayPal.


Shipment.ShipFromAddress
  .AddressRecordType
AddressRecordTypeCodeType --- Indicates the nature of the address (e.g., residential or business). Not applicable to Half.com.
Shipment.ShipFromAddress
  .AddressStatus
AddressStatusCodeType --- PayPal address status. Not applicable to Half.com.
Shipment.ShipFromAddress
  .AddressUsage
AddressUsageCodeType --- This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

Applicable values:

•   CustomCode

Reserved for internal or future use.

•   DefaultShipping

This is default shipping address which is rendered to buyer on checkout.

•   Invalid

This is not a valid address. Please use another address.

•   Shipping

This is an address which is in user's address book. It can be used at the time of checkout.


Shipment.ShipFromAddress
  .CityName
string --- The name of the user's city. Also applicable to Half.com (for GetOrders).
Shipment.ShipFromAddress
  .CompanyName
string --- User's company name. Only returned if available. Not applicable to Half.com.
Shipment.ShipFromAddress
  .Country
CountryCodeType --- The two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.
Shipment.ShipFromAddress
  .CountryName
string --- The name of the user's country. Also applicable to Half.com (for GetOrders).
Shipment.ShipFromAddress
  .County
string --- County information for the user. This field applies to Classified Ad format listings and to the UK only. Not applicable to Half.com.
Shipment.ShipFromAddress
  .ExternalAddressID
string --- ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders).
Shipment.ShipFromAddress
  .FirstName
string --- Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.
Shipment.ShipFromAddress
  .InternationalName
string --- Seller's international name that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
Shipment.ShipFromAddress
  .InternationalStateAndCity
string --- International state and city for the seller's payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
Shipment.ShipFromAddress
  .InternationalStreet
string --- Seller's international street address that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
Shipment.ShipFromAddress
  .LastName
string --- Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.
Shipment.ShipFromAddress.Name string --- User's name for the address. Also applicable to Half.com (for GetOrders).
Shipment.ShipFromAddress.Phone string --- User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number.

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.

Also applicable to Half.com (for GetOrders).
Shipment.ShipFromAddress
  .Phone2
string --- Secondary Phone number of the lead. Not returned if information is unavailable.
Shipment.ShipFromAddress
  .Phone2AreaOrCityCode
string --- Area or City Code of a user's secondary phone number. This field applies to Classified Ad format listings only.
Shipment.ShipFromAddress
  .Phone2CountryCode
CountryCodeType --- Standard ISO code for the country of a user's secondary telephone phone number. For Classifed Ad format listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad format listings only.

Applicable values: See Phone2CountryCode.
Shipment.ShipFromAddress
  .Phone2CountryPrefix
string --- Country prefix of a user's secondary phone number. This value is derived from inputs supplied for Phone2CountryCode. This field applies to Classified Ad format listings only.
Shipment.ShipFromAddress
  .Phone2LocalNumber
string --- The local number portion of the user's secondary phone number. This field applies to Classified Ad format listings only.
Note: The full secondary phone number is constructed by combining Phone2LocalNumber with Phone2AreaOrCityCode and Phone2CountryPrefix. Starting with API release 497, the full phone number can be entered in Phone2LocalNumber. Refer to the release notes for additional information.
Shipment.ShipFromAddress
  .PhoneAreaOrCityCode
string --- Area or City Code of a user's primary phone number. This field applies to Classified Ad format listings only.
Shipment.ShipFromAddress
  .PhoneCountryCode
CountryCodeType --- Standard ISO code for the country of the user's primay telephone phone number. For Classifed Ad format listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad format listings only.

Applicable values: See PhoneCountryCode.
Shipment.ShipFromAddress
  .PhoneCountryPrefix
string --- Country Prefix of the secondary phone number. This value is derived from inputs supplied for PhoneCountryCode. This field applies to Classified Ad format listings only.
Shipment.ShipFromAddress
  .PhoneLocalNumber
string --- The local number portion of the user's primary phone number. This field applies to Classified Ad format listings only.
Note: The full primary phone number is constructed by combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix. Starting with API release 497, the full phone number can be entered in PhoneLocalNumber. Refer to the release notes for additional information.
Shipment.ShipFromAddress
  .PostalCode
string --- User's postal code.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Also applicable to Half.com (for GetOrders).
Shipment.ShipFromAddress
  .ReferenceID
string --- Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider.

Example: "Reference #1234567890123456"
Shipment.ShipFromAddress
  .StateOrProvince
string --- The region of the user's address. Also applicable to Half.com (for GetOrders).
Shipment.ShipFromAddress
  .Street
string --- A concatenation of Street1 and Street2, primarily for RegistrationAddress. Not applicable to Half.com.
Shipment.ShipFromAddress
  .Street1
string --- Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Shipment.ShipFromAddress
  .Street2
string --- Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Shipment.ShipmentID long ---
Shipment.ShipmentLineItem ShipmentLineItemType --- Contains information about one or more order line items in a Global Shipping Program package. Required or returned if the value of ShippingCarrierUsed is GlobalShipping_MultiCarrier.
Shipment.ShipmentLineItem
  .LineItem
LineItemType ---,
repeatable: [1..*]
Contains information about one order line item in a Global Shipping Program package. The package can contain multiple units of a given order line item, and multiple order line items.
Shipment.ShipmentLineItem
  .LineItem.CountryOfOrigin
string --- The Country of Manufacture for the order line item; this is required for customs. This should identify the country in which more than 50% of the value of the item was created.

This value must conform to the ISO 3166 two-letter country code standard. To see the list of currently supported codes, and the English names associated with each code (e.g., KY="Cayman Islands"), call GeteBayDetails with DetailName set to CountryDetails.
Shipment.ShipmentLineItem
  .LineItem.Description
string --- The item description of the order line item, based on its ItemID.
Shipment.ShipmentLineItem
  .LineItem.ItemID
ItemIDType (string) --- Unique identifier for the eBay item listing of the order line item. A listing can have multiple order line items (transactions), but only one ItemID. Unless an OrderLineItemID or SKU value is specified in the same node, this field is required for each ItemTransactionID node included in the request.
Shipment.ShipmentLineItem
  .LineItem.Quantity
int --- The number of units of the order line item in this package; this is required for customs. The seller must ensure that this matches the quantity of the order line item enclosed in the package.

This value must be a positive integer, and it can't be greater than the quantity of this item specified in the original transaction.
Shipment.ShipmentLineItem
  .LineItem.TransactionID
string --- Unique identifier for an eBay order line item (transaction). The TransactionID should match the ItemID specified in each ItemTransactionID node included in the request. Optionally, an OrderLineItemID value can substitute for the ItemID/TransactionID pair.
Shipment
  .ShipmentTrackingDetails
ShipmentTrackingDetailsType ---,
repeatable: [?..*]
Container consisting of the tracking number and shipping carrier associated with the shipment of one item (package).

Because an order can have multiple line items and/or packages, there can be multiple ShipmentTrackingDetails containers under the Shipment container.
Shipment
  .ShipmentTrackingDetails
  .ShipmentLineItem
ShipmentLineItemType --- Contains information about one or more order line items in a Global Shipping Program package. Required or returned if the value of ShippingCarrierUsed is GlobalShipping_MultiCarrier.
Shipment
  .ShipmentTrackingDetails
  .ShipmentLineItem.LineItem
LineItemType ---,
repeatable: [1..*]
Contains information about one order line item in a Global Shipping Program package. The package can contain multiple units of a given order line item, and multiple order line items.
Shipment
  .ShipmentTrackingDetails
  .ShipmentLineItem.LineItem
  .CountryOfOrigin
string --- The Country of Manufacture for the order line item; this is required for customs. This should identify the country in which more than 50% of the value of the item was created.

This value must conform to the ISO 3166 two-letter country code standard. To see the list of currently supported codes, and the English names associated with each code (e.g., KY="Cayman Islands"), call GeteBayDetails with DetailName set to CountryDetails.
Shipment
  .ShipmentTrackingDetails
  .ShipmentLineItem.LineItem
  .Description
string --- The item description of the order line item, based on its ItemID.
Shipment
  .ShipmentTrackingDetails
  .ShipmentLineItem.LineItem
  .ItemID
ItemIDType (string) --- Unique identifier for the eBay item listing of the order line item. A listing can have multiple order line items (transactions), but only one ItemID. Unless an OrderLineItemID or SKU value is specified in the same node, this field is required for each ItemTransactionID node included in the request.
Shipment
  .ShipmentTrackingDetails
  .ShipmentLineItem.LineItem
  .Quantity
int --- The number of units of the order line item in this package; this is required for customs. The seller must ensure that this matches the quantity of the order line item enclosed in the package.

This value must be a positive integer, and it can't be greater than the quantity of this item specified in the original transaction.
Shipment
  .ShipmentTrackingDetails
  .ShipmentLineItem.LineItem
  .TransactionID
string --- Unique identifier for an eBay order line item (transaction). The TransactionID should match the ItemID specified in each ItemTransactionID node included in the request. Optionally, an OrderLineItemID value can substitute for the ItemID/TransactionID pair.
Shipment
  .ShipmentTrackingDetails
  .ShipmentTrackingNumber
string --- Required if ShippingCarrierUsed is supplied. 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). Typically, you should avoid spaces and hyphens. Returned only if set. Returned for Half.com as well.
Shipment
  .ShipmentTrackingDetails
  .ShippingCarrierUsed
string --- Required if ShipmentTrackingNumber is supplied. Name of the shipping carrier used to ship the item. Although this value can be any value, since it is not checked by eBay, commonly used shipping carriers can be found by calling GeteBayDetails with DetailName set to ShippingCarrierDetails and examining the returned ShippingCarrierCodeTypes.

For those using UPS Mail Innovations, supply the value UPS-MI for UPS Mail Innnovations. Buyers will subsequently be sent to the UPS Mail Innovations website for tracking.

For those using FedEx SmartPost in a CompleteSale callsupply the value FedEx. Buyers will subsequently be sent to the appropriate web site for tracking status. (The buyer is sent to the UPS Mail Innovations website if UPS-MI is specified, or to the FedEx website if FedEx is specified.) Returned only if set. Returned for Half.com as well.
Shipment
  .ShipmentTrackingNumber
string --- The tracking number associated with one package of a shipment. The seller is responsible for the accuracy of the shipment tracking number. eBay verifies the tracking number is unique (across all of a seller's orders) and consistent with the numbering scheme used by the specified shipping carrier. eBay cannot verify the accuracy of the tracking number. This field is required if ShippingCarrierUsed is included in the call request.

Sellers can specify multiple tracking numbers for the same ShippingCarrierUsed by separating the tracking numbers with commas.

ShippingCarrierUsed and ShipmentTrackingNumber are dependent upon each other. You must either specify both, or specify neither.
Shipment.ShippedTime dateTime --- The date and time that the seller handed off the package(s) to the shipping carrier. If this field is not included in the request, the timestamp of the call execution is used as the shipped time. Note that sellers have the ability to set this value up to 3 calendar days in the future.
Shipment.ShippingAddress AddressType --- The address to which the item is to be shipped.
Shipment.ShippingAddress
  .AddressID
string --- Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address.
Shipment.ShippingAddress
  .AddressOwner
AddressOwnerCodeType --- The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com.

Applicable values:

•   CustomCode

Reserved for internal or future use.

•   eBay

This value indicates that the shipping address being referenced is on file with eBay.

•   PayPal

This value indicates that the shipping address being referenced is on file with PayPal.


Shipment.ShippingAddress
  .AddressRecordType
AddressRecordTypeCodeType --- Indicates the nature of the address (e.g., residential or business). Not applicable to Half.com.
Shipment.ShippingAddress
  .AddressStatus
AddressStatusCodeType --- PayPal address status. Not applicable to Half.com.
Shipment.ShippingAddress
  .AddressUsage
AddressUsageCodeType --- This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

Applicable values:

•   CustomCode

Reserved for internal or future use.

•   DefaultShipping

This is default shipping address which is rendered to buyer on checkout.

•   Invalid

This is not a valid address. Please use another address.

•   Shipping

This is an address which is in user's address book. It can be used at the time of checkout.


Shipment.ShippingAddress
  .CityName
string --- The name of the user's city. Also applicable to Half.com (for GetOrders).
Shipment.ShippingAddress
  .CompanyName
string --- User's company name. Only returned if available. Not applicable to Half.com.
Shipment.ShippingAddress
  .Country
CountryCodeType --- The two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.
Shipment.ShippingAddress
  .CountryName
string --- The name of the user's country. Also applicable to Half.com (for GetOrders).
Shipment.ShippingAddress
  .County
string --- County information for the user. This field applies to Classified Ad format listings and to the UK only. Not applicable to Half.com.
Shipment.ShippingAddress
  .ExternalAddressID
string --- ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders).
Shipment.ShippingAddress
  .FirstName
string --- Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.
Shipment.ShippingAddress
  .InternationalName
string --- Seller's international name that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
Shipment.ShippingAddress
  .InternationalStateAndCity
string --- International state and city for the seller's payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
Shipment.ShippingAddress
  .InternationalStreet
string --- Seller's international street address that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
Shipment.ShippingAddress
  .LastName
string --- Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.
Shipment.ShippingAddress.Name string --- User's name for the address. Also applicable to Half.com (for GetOrders).
Shipment.ShippingAddress.Phone string --- User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number.

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.

Also applicable to Half.com (for GetOrders).
Shipment.ShippingAddress
  .Phone2
string --- Secondary Phone number of the lead. Not returned if information is unavailable.
Shipment.ShippingAddress
  .Phone2AreaOrCityCode
string --- Area or City Code of a user's secondary phone number. This field applies to Classified Ad format listings only.
Shipment.ShippingAddress
  .Phone2CountryCode
CountryCodeType --- Standard ISO code for the country of a user's secondary telephone phone number. For Classifed Ad format listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad format listings only.

Applicable values: See Phone2CountryCode.
Shipment.ShippingAddress
  .Phone2CountryPrefix
string --- Country prefix of a user's secondary phone number. This value is derived from inputs supplied for Phone2CountryCode. This field applies to Classified Ad format listings only.
Shipment.ShippingAddress
  .Phone2LocalNumber
string --- The local number portion of the user's secondary phone number. This field applies to Classified Ad format listings only.
Note: The full secondary phone number is constructed by combining Phone2LocalNumber with Phone2AreaOrCityCode and Phone2CountryPrefix. Starting with API release 497, the full phone number can be entered in Phone2LocalNumber. Refer to the release notes for additional information.
Shipment.ShippingAddress
  .PhoneAreaOrCityCode
string --- Area or City Code of a user's primary phone number. This field applies to Classified Ad format listings only.
Shipment.ShippingAddress
  .PhoneCountryCode
CountryCodeType --- Standard ISO code for the country of the user's primay telephone phone number. For Classifed Ad format listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad format listings only.

Applicable values: See PhoneCountryCode.
Shipment.ShippingAddress
  .PhoneCountryPrefix
string --- Country Prefix of the secondary phone number. This value is derived from inputs supplied for PhoneCountryCode. This field applies to Classified Ad format listings only.
Shipment.ShippingAddress
  .PhoneLocalNumber
string --- The local number portion of the user's primary phone number. This field applies to Classified Ad format listings only.
Note: The full primary phone number is constructed by combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix. Starting with API release 497, the full phone number can be entered in PhoneLocalNumber. Refer to the release notes for additional information.
Shipment.ShippingAddress
  .PostalCode
string --- User's postal code.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Also applicable to Half.com (for GetOrders).
Shipment.ShippingAddress
  .ReferenceID
string --- Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider.

Example: "Reference #1234567890123456"
Shipment.ShippingAddress
  .StateOrProvince
string --- The region of the user's address. Also applicable to Half.com (for GetOrders).
Shipment.ShippingAddress
  .Street
string --- A concatenation of Street1 and Street2, primarily for RegistrationAddress. Not applicable to Half.com.
Shipment.ShippingAddress
  .Street1
string --- Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Shipment.ShippingAddress
  .Street2
string --- Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Shipment.ShippingCarrierUsed string --- The shipping carrier used to ship the package. This value can be any combination of alphanumeric characters and it is not checked and verified by eBay. This field is required if ShipmentTrackingNumber is included in the call request.

ShippingCarrierUsed and ShipmentTrackingNumber are dependent upon each other. You must either specify both, or specify neither.
Shipment.ShippingFeature ShippingFeatureCodeType ---
Shipment.ShippingPackage ShippingPackageCodeType --- The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input.
Shipment.ShippingServiceUsed token --- The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input.
Shipment.Status ShipmentStatusCodeType --- Status, for revise only
Shipment.WeightMajor MeasureType (decimal) --- See the documentation regarding "Working with Item Weights". The 'unit' attribute can have a value of lbs.
Shipment.WeightMinor MeasureType (decimal) --- See the documentation regarding "Working with Item Weights". The 'unit' attribute is optional and assumed to be the minor compared to the value of 'unit' in WeightMajor.



Back to top

SetShipmentTrackingInfo 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"?>
<SetShipmentTrackingInfoResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <OrderLineItemID> string </OrderLineItemID>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <BotBlock> BotBlockResponseType
    <BotBlockAudioUrl> string </BotBlockAudioUrl>
    <BotBlockToken> string </BotBlockToken>
    <BotBlockUrl> string </BotBlockUrl>
  </BotBlock>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <DuplicateInvocationDetails> DuplicateInvocationDetailsType
    <DuplicateInvocationID> UUIDType (string) </DuplicateInvocationID>
    <InvocationTrackingID> string </InvocationTrackingID>
    <Status> InvocationStatusType </Status>
  </DuplicateInvocationDetails>
  <EIASToken> string </EIASToken>
  <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>
    <UserDisplayHint> boolean </UserDisplayHint>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <ExternalUserData> string </ExternalUserData>
  <HardExpirationWarning> string </HardExpirationWarning>
  <Message> string </Message>
  <NotificationEventName> string </NotificationEventName>
  <NotificationSignature> string </NotificationSignature>
  <RecipientUserID> string </RecipientUserID>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</SetShipmentTrackingInfoResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
OrderLineItemID string --- OrderLineItemID is required upon input and always returned in the response. You can use this field to track whether or not a response is returned for every request, and to match specific responses to Specific requests.
Standard Output Fields  
Ack AckCodeType --- A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.

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.)
BotBlock BotBlockResponseType --- Container of token, image URL and audio URL.
BotBlock.BotBlockAudioUrl string --- The URL of the audio-clip that your application should provide for sight-impaired users. The BotBlockAudioUrl audio-clip corresponds to the BotBlockUrl image.
BotBlock.BotBlockToken string --- An encrypted token generated by eBay when the botblock mechanism is triggered. This token is mapped to BotBlockUrl and BotBlockAudioUrl.
BotBlock.BotBlockUrl string --- The URL of the image that your application should display to the user for a botblock challenge.
Build string --- This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string --- Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
DuplicateInvocationDetails DuplicateInvocationDetailsType --- Information that explains a failure due to a duplicate InvocationID being passed in.
DuplicateInvocationDetails
  .DuplicateInvocationID
UUIDType (string) --- The duplicate InvocationID.
DuplicateInvocationDetails
  .InvocationTrackingID
string --- The id that identifies the business item the previous API invocation created. For example, the ItemID of the item created by an AddItem call.
DuplicateInvocationDetails
  .Status
InvocationStatusType --- The status of the previous call that used the InvocationID.

Applicable values:

•   CustomCode

 

•   Failure

•   InProgress

•   Success


EIASToken string --- Unique Identifier of Recipient user ID of the notification. Only returned by Platform Notifications (not for regular API call responses).
Errors ErrorType ---,
repeatable: [0..*]
A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.

Errors.ErrorClassification ErrorClassificationCodeType --- 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 --- 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 ---,
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 [UNDEFINED] 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.Value string --- The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string --- A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType --- 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

The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.

  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, 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.


See the Compatible Application Check section of the eBay Features Guide for more information.

•   Warning

The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.


Errors.ShortMessage string --- A brief description of the condition that raised the error.
Errors.UserDisplayHint boolean --- Indicates whether the error message text is intended to be displayed to an end user or intended only to be parsed by the application. If true or not present (the default), the message text is intended for the end user. If false, the message text is intended for the application, and the application should translate the error into a more appropriate message. Only applicable to Item Specifics errors and warnings returned from listing requests.
ExternalUserData string --- An application subscribing to notifications can include an XML-compliant string, not to exceed 256 characters, which will be returned. The string can identify a particular user. Any sensitive information should be passed with due caution.

To subscribe to and receive eBay Buyer Protection notifications, this field is required, and you must pass in 'eBP notification' as a string.
HardExpirationWarning string --- Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Message string --- Supplemental information from eBay, if applicable. May elaborate on errors (such as how a listing violates eBay policies) or provide useful hints that may help a seller increase sales. This data can accompany the call's normal data result set or a result set that contains only errors.

Applications must recognize when the Message field is returned and provide a means to display the listing hints and error message explanations to the user.

The string can return HTML, including TABLE, IMG, and HREF elements. In this case, an HTML-based application should be able to include the HTML as-is in the HTML page that displays the results. A non-HTML application would need to parse the HTML and convert the table elements and image references into UI elements particular to the programming language used. As usual for string data types, the HTML markup elements are escaped with character entity references (e.g.,<table><tr>...).

See Standard Data for All Calls.

NotificationEventName string --- Event name of the notification. Only returned by Platform Notifications.
NotificationSignature string --- A Base64-encoded MD5 hash that allows the recipient of a Platform Notification to verify this is a valid Platform Notification sent by eBay.
RecipientUserID string --- Recipient user ID of the notification. Only returned by Platform Notifications.
Timestamp dateTime --- This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string --- The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Back to top

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

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 are 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.
<?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>



Back to top

SetShipmentTrackingInfo Change History

Version Description
809
2013-02-06
  • SetShipmentTrackingInfoRequest (doc change): For orders on the eBay India site, SetShipmentTrackingInfo cannot be used if the buyer uses PaisaPay as the payment method.
727
2011-06-22
  • ShipmentTrackingNumber, ShippingCarrierUsed (modified): ShipmentTrackingNumber and ShippingCarrierUsed are no longer always required. These fields are now conditionally required. If you specify one, you must specify the other, but now they can both be omitted from the request.
589
2008-11-29
  • (added) New call.

Back to top

User-Contributed Notes

 

Copyright © 2008–2014 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.