API details

Shipping services returned by GeteBayDetails that either will be — or already have been — deprecated include the following in their associated ShippingServiceDetails containers:

• DeprecationDetails

  This container includes information about when the deprecation of a shipping service is/was announced, and what type of announcement(s) will be broadcast:

  • ShippingServiceDetails.DeprecationDetails.AnnouncementStartTime

    The date and time on which announcements about the shipping service's deprecation can start.

  • ShippingServiceDetails.DeprecationDetails.EventTime

    The specific date and time when the shipping service was/will be deprecated.

    This is also the date and time when announcements regarding the shipping service's deprecation will cease.

  • ShippingServiceDetails.DeprecationDetails.MessageType

    Identifies the type of message that will be made for the associated shipping service's deprecation.

    Available options are:

    • None

      No message is to be made available.

    • Deprecation

      Messaging will be sent only during the to-be-deprecated period (i.e., between ShippingServiceDetails.DeprecationDetails.AnnouncementStartTime and ShippingServiceDetails.DeprecationDetails.EventTime).

    • Mapping

      Messaging will be sent out during the mapping period which is any time following ShippingServiceDetails.DeprecationDetails.EventTime.

    • DeprecationAndMapping

      Messaging will be sent out starting on ShippingServiceDetails.DeprecationDetails.AnnouncementStartTime with no scheduled end date specified.

      Appropriate messages will be issued depending on whether they are being sent during the deprecation period or the mapping period. Refer to the Example below for further clarification.

• ShippingServiceDetails.MappedToShippingServiceID

  The numerical id of the recommended replacement for the deprecated shipping service.

Example

For example, GeteBayDetails is called and the following information is returned within the ShippingServiceDetails container for a shipping service:

• ShippingServiceDetails.DeprecationDetails.AnnouncementStartTime = June 1
• ShippingServiceDetails.DeprecationDetails.EventTime = July 1
• ShippingServiceDetails.DeprecationDetails.MessageType = DeprecationAndMapping
• ShippingServiceDetails.MappedToShippingServiceID = 123456

Since the value returned for ShippingServiceDetails.DeprecationDetails.MessageType is DeprecationAndMapping, messages are to be issued during both the deprecation and mapping periods. Therefore:

• If it is before June 1, no warning is issued because the announcement period for the upcoming service deprecation has not started.
• Between June 1 and July 1, a warning is issued to sellers who create new listings via the API that include the soon-to-be-deprecated shipping service.
• After July 1, if a seller creates a new listing via the API that offers the now-deprecated shipping service, eBay automatically maps it to service 123456 and issues a warning that the mapping has occurred.