Just getting started with the Fulfillment API? See the following documents for details on using this API:

The API release history

The following table lists recent Fulfillment API releases. For older releases, see the Fulfillment API release notes archive.

Version Release Date Summary of Release

Version 1.20.4

2024-03-14

 Added schema to return appointment details.

Version 1.20.3

2023-10-23

 Added contentOnHold field to InfoFromBuyer container.

Version 1.20.2

2023-09-21

Added a new error code to addEvidence and updateEvidence methods

Added a new EvidenceTypeEnum value.

Version 1.20.1

2023-08-14

 Added support for collecting appropriate "Collect and Remit" (C&R) tax in Jersey, Kazakhstan, Belarus, and Malaysia.

Version 1.20.0

2023-03-31

Support for linked orders has been added.

All orders now show buyer address.

Version 1.19.19

2023-02-16

The date threshold for retrieving past orders has been increased from 90 days to two years.

Personally Identifiable Information (PII) for past orders older than 90 days is now masked.

Version 1.19.18

2023-01-09

Added identification of the specific variation ordered for multi-variation listings orders, support for import VAT sales tax, and support for seller notes in payment disputes.

Version 1.19.17

2022-10-19

EU and UK Payments regulations now require Digital Signatures to be included in HTTP payloads for the issueRefund method.

Version 1.19.16

2022-10-04

Added support for eBay shipping.

Version 1.19.15

2022-09-19

Added support for eBay International Shipping.

Version 1.19.14

2022-06-30

Added and updated error codes for the uploadEvidenceFile method.

Version 1.20.4

Added schema to return appointment details

This release provides appointment details selected by the buyer, to the installation provider (see the Separate orders can be linked use case). The schema update includes adding the appointment container to the FulfillmentStartInstruction type available through the getOrder and getOrders methods. This container provides appointment details through the following fields.

  • appointmentEndTime

  • appointmentStartTime

  • appointmentStatus©

  • appointmentType

  • appointmentWindow

  • serviceProviderAppointmentDate

To support these new fields, the following types were also added.

Version 1.20.3

The following changes have been incorporated in this release.

Schema change

The following field has been added to the InfoFromBuyer container which is used by the PaymentDispute type and the getPaymentDispute method:

  • contentOnHold: When this value is true it indicates that an item has been put on hold due to a violation of eBay Policy.

Version 1.20.2

This release incorporates the changes described in the following sections.

New error message

The following error message has been added to the addEvidence and updateEvidence methods:

  • 33100: Invalid input request

Schema changes

The following enumeration value has been added to EvidenceTypEnum:

  • OPTIONAL_SUPPORTING_DOCUMENTS: This enumeration value indicates that the evidential documentation is optional.

Version 1.20.1

This release adds support collecting appropriate "Collect and Remit" (C&R) tax in Jersey, Kazakhstan, Belarus, and Malaysia.

Schema changes

To support the collecting of C&R tax in Malaysia, the following enumeration value has been added to TaxTypeEnum:

  • SST: This enumeration value indicates that a "Sales & Service Tax" was charged to the buyer against the order line item.

Version 1.20.0

This release adds support for linking separate orders, which may be from different sellers (see the Separate orders can be linked use case), and also returns the buyer registration address.

Added schema to support linking of separate orders

The linkedOrderLineItems array (array of LinkedOrderLineItem type) was added to the LineItem type to provide line items that are related to the corresponding order, but not a part of that order. Details can identify the linked seller and also include delivery times, item information, and order information through the following fields that were added to the getOrder and getOrders methods:

  • lineItemAspects (an array of NameValuePair)

  • lineItemId

  • maxEstimatedDeliveryDate

  • minEstimatedDeliveryDate

  • orderId

  • sellerId

  • shipments (an array of TrackingInfo)

  • title

Added schema to return the buyer address

Note: The buyer registration address is always returned, even if the ship to address and buyer address are the same for all sites and regions.

The buyerRegistrationAddress container (ExtendedContact type) was added to the buyer container. This returns buyer contact information through the following fields that were added to the getOrder and getOrders methods:

  • companyName

  • contactAddress (Address type)

  • email

  • fullName

  • primaryPhone (PhoneNumber type)

Version 1.19.19

This release incorporates the following changes.

Expanded date threshold for retrieving past orders

The threshold for retrieving past orders has been expanded from 90 days to two years.

To support this change, the following error code has been updated as follows:

  • 30830: Start date must be within 2 years from present date.

Fields that may return Personally Identifiable Information (PII) are masked for orders older than 90 days

When retrieving orders that are older than 90 days, information returned in the following fields may include PII and therefore are now masked:

  • GiftDetails.message
  • GiftDetails.recipientEmail
  • GiftDetails.senderName

Version 1.19.18

This release adds the identification of the specific variation ordered for multi-variation listings orders and support for VAT sales tax charged for imported order line items, and support for seller notes in payment disputes.

Added schema to identify the specific variation ordered (multi-variation listings orders only)

The following container was added to the getOrder and getOrders methods:

  • variationAspects container provides an array of aspect name-value pairs that identifies the specific variation of a multi-variation listing. This array can contain multiple name-value pairs, such as color:blue and size:large, and will only be returned for orders created from a multiple-variation listing.

New enumeration value added for VAT sales tax charged on imported order line items

In the getOrder and getOrders methods, an enumerated value was added to the taxType field:

  • IMPORT_VAT: This enumeration value indicates that the Value-Added Tax (VAT) was charged to the buyer against an imported order line item (only applies to international orders). VAT is not applicable in all countries, including the United States.

Support for seller notes in payment disputes

Sellers have the ability to enter up to 1000 characters when contesting a payment dispute. The Fulfillment API now returns that information in the "note" field in the methods contestPaymentDispute and getPaymentDispute.

Version 1.19.17

Due to EU and UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for the issueRefund method when called on behalf of EU/UK sellers. Refer to Digital Signatures for APIs for information about creating signatures to be included in the HTTP payload.

Version 1.19.16

API updates

This API release contains the following update.

Added schema to support eBay shipping

An EbayCollectedCharges type was added to the LineItem type to provide the breakdown of costs that are collected by eBay from the buyer.

The following containers were added to the getOrder and getOrders methods:

Note: Currently, ebayCollectedCharges and ebayShipping are returned only if eBay is directly charging the buyer for eBay shipping.

  • ebayCollectedCharges container consists of a breakdown of costs that are collected by eBay from the buyer for this order.

  • ebayShipping container consists of costs related to eBay Shipping collected by eBay from the buyer of this order.

An EbayShipping type was added to the Program type to provide information about the management of the shipping for the order.

The following container was added was added to the getOrder and getOrders methods:

  • shippingLabelProvidedBy container provides the shipping label provider. If EBAY, this order is managed by eBay shipping and a free shipping label by eBay is downloadable by the seller via the eBay website

Tip: See more details about Authenticity Guarantee and how eBay shipping applies to eligible sneaker listings.

Version 1.19.15

API updates

This API release contains the following update.

Support for eBay International Shipping added

Support for eBay International Shipping has been added. On the US marketplace, the Global Shipping Program is scheduled to be replaced by this new intermediated shipping program (eBay International Shipping). US Sellers opted in to the Global Shipping Program will automatically get opted into eBay International Shipping once it becomes available to them. All US sellers will be migrated by March 31, 2023. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available.

Added schema to support eBay International shipping

An EbayInternationalShipping type was added to provide details about an order line item being managed through eBay International Shipping.

The following containers were added or modified:

  • ebayInternationalShipping container was added to the getOrder and getOrders methods

  • ebaySupportedFulfillment container (and the FulfillmentStartInstruction type) now supports eBay International Shipping

Version 1.19.14

API updates

This API release contains the following update.

Error codes

The following error codes were added to the uploadEvidenceFile method:

  • Error 33105: You have reached the maximum number of files that you can upload.
  • Error 33106: The file name should not be empty and should not exceed 255 characters.
  • Error 33107: Only one file can be uploaded per request.

Additionally, the file size limit described in error 33006 was changed from 10MB to 1.5MB.

In the methods addEvidence and updateEvidence, the description for error code 33104 was updated to state: "The combined size of attached files should be 1.5MB or less."