Etsy Open Api Versions Save

• 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

• 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

• 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

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

To help protect shoppers’ privacy, we put some additional limits on the buyer info we share via the Etsy API. It only affects buyer_email address field: most applications will not see this field returned in the responses of the endpoints anymore. Only in rare cases is this information included.

This change does not impact your API key’s ability to leverage the Etsy API. It will only affect if the buyer_email address field is returned in the responses of the endpoints. If your application is not authorized to access this field, the endpoint will still return responses as normal, without this field being present in the response.

Bug Fixes:

• Change ShopReceipt payment_email field to nullable.

Addressed a bug in the documentation missing the “nulll” label for nullable fields. If your application generates models from the OAS schema, please regenerate them using the latest version.

getListing

• Updated ShopListing.getListing to better explain why an error might be occurring. Now, in some scenarios a 422 will be returned with additional information as opposed to just a generic 500 error.

getListing

• We have updated the response of ShopListing.getListing to accurately reflect the translation field as a key-value map as intended. Now, when the value is not empty, a map of all supported languages returned. Languages without a translation will be mapped to null, while languages with translations will be mapped to their appropriate values. If the value is empty, a map of all supported languages is returned, all keyed to null. Please see updated documentation for examples.

deleteListingImage

• Prevent client's from deleting all listing images. Listings must have at least one image.