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.19.13 2022-06-16

Effective July 1, 2022, eBay is required to collect and remit sales tax in Canada; the following changes have been incorporated in this release:

  • Added support to collect and remit (C&R) Canada sales tax
  • Sales tax is now being collected for Digitally Delivered Goods (DDG)

Version 1.19.12 2022-05-31 Two error codes were added and three error codes were updated for the issueRefund method.
Version 1.19.11 2022-05-05 Added new Schema to support eBay's Vault program.
Version 1.19.10 2021-10-18 Changed the limit maximum value to 200 for getOrders method.
Version 1.19.9 2021-08-18 Added two enumeration values (APPEAL_DENIED and APPEAL_GRANTED) for the ActivityEnum type.
Version 1.19.8 2021-07-26 Added a new enumeration value (DISPUTE_REVERSED) for the ActivityEnum type.
Version 1.19.7 2021-06-21 Updated description of Amount for the getOrder and getOrders methods; added VAT support to be collected in EU countries starting on July 1, 2021
Version 1.19.6 2021-06-08 Added new Schema to support the return of fulfillment program information.
Version 1.19.5 2021-06-01 Added new Schema to support the return of VAT identifiers.
Version 1.19.4 2021-05-10 Added new error code to the issueRefund method for seller-initiated refunds.
Version 1.19.3 2021-01-15 Added a new enumeration value (DISPUTE_REOPENED) for the ActivityEnum type.

Version 1.19.13

API updates

This API release contains the following updates.

eBay now collects and remits Canadian federal and provincial sales tax

Canadian federal and provincial sales tax information is now returned as part of the getOrder and getOrders methods.

Sales tax is now being collected for Digitally Delivered Goods (DDG)

Sales tax information collected on DDG is now returned as part of the getOrder and getOrders methods.

Version 1.19.12

API updates

This API release contains the following update.

New error codes

The following error codes were added to the issueRefund method:

Code Meaning
34929 You cannot refund this order yet since the buyer payment has not been processed. Please try again later.
34930 Default payment method limit exceeded. Please use a different payment option or try again later.

Error code updates

The following issueRefund method error code meanings were updated:

Code Meaning
34917 This order was already refunded.
34920 It's too late to issue a refund for this order.
34923 Refund cannot be issued for this type of order.

Version 1.19.11

API updates

This API release contains the following update.

New schema to support eBay's Vault program

The following schema changes have been made to the getOrder and getOrders methods in this release to support eBay's Vault program:

  • ebayVault field added to Program type: This field provides information about the specific eBay Vault program selected for eligible items within an order.
  • EbayVaultProgram type added: This type provides information about the eBay vault program that has been selected for an order and includes the following field:
    • fulfillmentType: This field specifies how an eBay vault order will be fulfilled.
  • New EbayVaultFulfillmentTypeEnum: Specifies which EbayVaultProgram has been selected for an order.
  • New FULFILLED_BY_EBAY enumeration value added to FulfillmentInstructionsType: Indicates that eBay will package and ship an order as specified by fulfillmentType.

Version 1.19.10

API updates

This API release contains the following update.

Updated limit

The limit value (the number of orders to return per page of the result set) used by the getOrders method now has a maximum value of 200.

Version 1.19.9

API updates

This API release contains the following update.

New enumeration values

Two enumeration values were added to the ActivityEnum for the PaymentDisputeActivity type used by the getActivities method.

  • APPEAL_DENIED: This enumeration value indicates eBay has declined the seller's appeal and upheld the original decision.
  • APPEAL_GRANTED: This enumeration value indicates eBay has granted the seller's appeal.

Version 1.19.8

API updates

This API release contains the following update.

New enumeration value

A new enumeration value was added to the ActivityEnum for the PaymentDisputeActivity type used by the getActivities method.

The new enumeration value, DISPUTE_REVERSED, indicates that in the case of a dispute that was previously closed as Seller Lost, the decision has been reversed to Seller Won. eBay will credit back to the seller the amount that was recouped by eBay when the dispute was originally closed as Seller Lost.

Version 1.19.7

API updates

This API release contains the following updates.

Updated description for getOrder and getOrders methods

The description of Amount in the getOrder and getOrders methods was updated to remove these notes:

  • Removed note for getOrder: This logic change does not apply to sellers opted in to eBay managed payments, and any 'Collect and Remit' tax is fully handled by eBay, and the proceeds of this tax is never distributed through seller payouts. Also, for sellers opted in to eBay managed payments, the lineItems.taxes array is returned empty.
  • Removed note for getOrders: This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.

Support for EU VAT tax collection added

This presently includes US state-mandated sales tax, 'Goods and Services' tax in Australia and New Zealand, and VAT collected for UK. Starting on July 1, 2021, VAT will be collected in EU countries. This update applies to the EbayCollectAndRemitTax type and the following fields for the getOrder and getOrders methods:

  • ebayCollectAndRemitTax
  • lineItems.total
  • lineItems.ebayCollectAndRemitTaxes
  • lineItems.ebayCollectAndRemitTaxes.amount
  • paymentSummary.totalDueSeller
  • paymentSummary.payments.amount
  • pricingSummary.total

Version 1.19.6

API updates

This API release contains the following update.

New Schema Added to Support the Fulfillment Program

The following schema changes to the getOrder and getOrders methods were implemented in this release to support the return of fulfillment program information:

  • fulfillmentProgram field added to the Program type: This field provides details about an order line item being handled by eBay fulfillment. It is only returned for paid orders being fulfilled by eBay or an eBay fulfillment partner.
  • EbayFulfillmentProgram type added: This type is used to provide details about an order line item being fulfilled by eBay or an eBay fulfillment partner and includes the following field:
    • fulfilledBy: The value returned in this field indicates the party that is handling fulfillment of the order line item.

      Valid value: EBAY

Version 1.19.5

API updates

This API release contains the following update.

Note: The eBay VAT ID and buyer VATIN fields will not start getting returned until June 30, 2021. On January 31, 2022, the orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.addressLine2 will stop being used to return VAT information, so developers should make sure they integrate with the new fields before that time.

New Schema Added to Support the Return of VAT Identifier Numbers

Schema changes including new enumeration values and fields were added with this release.

New TaxIdentifierTypeEnum

A new enumeration value was added to the TaxIdentifierTypeEnum for the TaxIdentifier type used by the getOrder and getOrders methods:

  • VATIN: This value indicates that the taxpayerId value is a VATIN number, which is the value-added tax identification number for the buyer. This identifier is used for value added tax purposes in many countries, including the countries of the European Union.

New EbayTaxReference type

The EbayTaxReference type was added to the EbayCollectAndRemitTax type for the getOrder and getOrders methods. This type is used to indicate the eBay VAT tax type and the eBay VAT identifier number. This field will be returned if VAT tax is applicable for the order and contains the following fields:

  • name: This field value is returned to indicate the VAT tax type, which will vary by country/region. This string value will be one of the following:
    • ABN: if this string is returned, the ID in the value field is an Australia tax ID
    • IOSS: if this string is returned, the ID in the value field is an eBay EU or UK IOSS number
    • IRD: if this string is returned, the ID in the value field is an eBay New Zealand tax ID
    • OSS: if this string is returned, the ID in the value field is an eBay Germany VAT ID
    • VOEC: if this string is returned, the ID in the value field is an eBay Norway tax ID
  • value: The value returned in this field is the VAT identifier number (VATIN), which will vary by country/region. This field will be returned if VAT tax is applicable for the order. The name field indicates the VAT tax type, which will vary by country/region:
    • ABN: eBay AU tax ID
    • IOSS: eBay EU IOSS number / eBay UK IOSS number
    • IRD: eBay NZ tax ID
    • OSS: eBay DE VAT ID
    • VOEC: eBay NO number

New ItemLocation type

The new ItemLocation type was added to the LineItem type for the getOrder and getOrders methods. This type describes the physical location of an order and contains the following fields:

  • countryCode: The two-letter ISO 3166 code representing the country of the address.
  • location: Indicates the geographical location of the item (along with the value in the countryCode field). This field provides city, province, state, or similar information.
  • postalCode: The postal code of the address.

Version 1.19.3

API updates

This API release contains the following update.

New enumeration value

A new enumeration value was added to the ActivityEnum for the PaymentDisputeActivity type used by the getActivities method.

The new enumeration value, DISPUTE_REOPENED, indicates that a previously closed payment dispute was reopened.