3.0.0 General Release 2024-11-20

Fulfillment-related changes in Canada

For Personal Keys

• Going forward, new personal keys for shops in the Canada will no longer be able to access createReceiptShipment or address fields (formatted_address, first_line, second_line, city, state, zip, country_iso) in getShopReceipt, getShopReceipts, and updateShopReceipt
• Existing personal keys will retain their existing access

For Commercial Keys

• New users (sellers) located in the Canada will no longer be able to use functionality in commercial-key applications based on createReceiptShipment or address fields (formatted_address, first_line, second_line, city, state, zip, country_iso) in getShopReceipt, getShopReceipts, and updateShopReceipt unless that Commercial Application is an Etsy Preferred Partner or is in an approved category
• Existing sellers using a Commercial Applications will retain their access to createReceiptShipment

For more information, please see these help articles:

• How to Use a Third-Party Provider to Ship Your Order
• New Shipping Partners To Help You Manage and Ship Orders

3.0.0 General Release 2024-10-21

Fulfillment-related changes in the United States

For Personal Keys

• Going forward, new personal keys for shops in the United States will no longer be able to access createReceiptShipment or formatted_address in getShopReceipt, getShopReceipts, and updateShopReceipt
• Existing personal keys will retain their existing access

For Commercial Keys

• New users (sellers) located in the United States will no longer be able to use functionality in commercial-key applications based on createReceiptShipment or formatted_address in getShopReceipt, getShopReceipts, and updateShopReceipt unless that Commercial Application is an Etsy Preferred Partner or is in an approved category
• Existing sellers using a Commercial Applications will retain their access to createReceiptShipment

For more information, please see this help article: How to Use a Third-Party Provider to Ship Your Order

3.0.0 General Release 2024-08-01

A few of ShopReceipt’s fields are now nullable. These include:

• first_line
• second_line
• city
• state
• zip
• country_iso

The impacted endpoints are:

• createReceiptShipment
• getShopReceipt
• getShopReceipts
• updateShopReceipt

Previously these fields would return an empty string if the request was not authorized to access the data, now the field will not be present in the response if the request is not authorized.

No changes were introduced on how access is determined.

3.0.0 General Release 2024-07-24

As part of the announcement today that sellers can customize their holiday processing schedule, we have released 2 new endpoints:

• getHolidayPreferences
• updateHolidayPreferences

Note: this new functionality is currently only supported in the US and Canada.

3.0.0 General Release 2024-07-01

formatted_address is now nullable. Clients will receive null if they are not authorized to access the field.

3.0.0 General Release 2024-06-03

There are 2 main changes in today's release:

5-Shop Limit for personal keys

Announcement

Fixed an issue that allowed some applications to authenticate more than 5 shops to their personal-key application.

• If your application is leveraging a personal key, once it hits 5 shops connected to it no more users will be allowed
• For applications that need to support more than 5 shops a commercial access key is required (and can be applied for from the Manage My Apps page)

Note: if you are currently operating under a personal key and have more than 5 shops connected, those shops will still be able to function while you upgrade your key, but any new shops will be declined until you have upgraded to a commercial level key

Fulfillment-related changes in Turkey

Announcement

For Personal Keys

• Going forward, new personal keys for shops in Turkey will no longer be able to access createReceiptShipment or formatted_address in getShopReceipt, getShopReceipts, and updateShopReceipt
• Existing personal keys will retain their existing access

For Commercial Keys

• New users (sellers) located in Turkey will no longer be able to use functionality in commercial-key applications based on createReceiptShipment or formatted_address in getShopReceipt, getShopReceipts, and updateShopReceipt unless that Commercial Application is an Etsy Preferred Partner or is in an approved category
• Existing sellers using a Commercial Applications will retain their access to createReceiptShipment

3.0.0 General Release 2024-03-04

• Added gift_sender as a new field to the following endpoints:
  • getShopReceipt
  • updateShopReceipt
  • getShopReceipts
  • createReceiptShipment
• In the previous experience of calling the createShopShippingProfileUpgrade and updateShopShippingProfileUpgrade endpoints, the request fails if any shipping profile field or any of its entries were invalid. We've updated this to fail the request only if the upgrade being operated on is invalid.
• When activating or manually renewing a physical listing through the endpoint updateListing, the shipping profile referenced by the shipping_profile_id and all of its fields, along with its entries and upgrades, will now be validated. If the shipping profile is invalid then the request will fail until all the shipping profile validation errors are fixed.
• We’re enhancing shipping profile error messages for a better user experience. Instead of being shown one validation error at a time, users will now see a concatenated string of error messages with all the shipping profile validation errors related to the current request.
• We expanded postal code requirements for shipping profiles for all countries we support instead of only US and CA. These changes are reflected in the following endpoints:
  • createShopShippingProfile
  • updateShopShippingProfile
  • createShopShippingProfileDestination
  • updateShopShippingProfileDestination
  • createShopShippingProfileUpgrade
  • updateShopShippingProfileUpgrade
  • updateListing

Here’s a list of the countries that will need a postal code in shipping profiles: https://developer.etsy.com/documentation/tutorials/fulfillment/#countries-requiring-postal-codes

3.0.0 General Release 2024-02-26

• Fixed an issue where calling deleteListingProperty would fail if the listing had broken properties.
• Updated the error response on updateListingProperty in the case of broken properties to include exactly which properties in the listing are broken and need to be fixed.
• Fixed a condition where ShopTransaction expected_ship_date is empty

3.0.0 General Release 2024-02-09

• Fixed an issue where refunds were appearing in a the buyer's currency whereas the original order was displayed in the seller's currency. The following endpoints now return refund data in the seller's currency to match:
  • getShopReceipt
  • getShopReceipts
  • updateShopReceipt

3.0.0 General Release 2024-02-06

• Bug Fix (Docs only): Change ShopListing state_timestamp field as nullable. This field was incorrectly labeled as non-nullable.
• Bug Fix (Docs only): Change UserAddress zip field to nullable. This field was incorrectly labeled as non-nullable.