Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Etsy Shop ShippingProfile API

The Shop ShippingProfile API from Etsy — 7 operation(s) for shop shippingprofile.

Etsy Shop ShippingProfile API is one of 28 APIs that Etsy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shop ShippingProfile. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 14 operations across 7 paths, and defines 11 schemas. It is described by OpenAPI 3.0.2, at version 3.0.0.

Requests are made against a single base URL, https://openapi.etsy.com.

14 operations 7 paths 11 schemas 3 DELETE5 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
3.0.0
Base URL
https://openapi.etsy.com
Authentication
API Key, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Etsy Shop ShippingProfile API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 20 scopes. By default, every request must be authenticated.

  • api_key — Every request to a v3 API endpoint must include this data in the format keystring:sharedsecret. Your keystring and shared secret are available on the [Your App…
  • oauth2 — Open API v3 supports authenticating via OAuth 2.0. More information about Etsy's specific implementation of OAuth2 can be found [here](/documentation/essential…

Paths & Operations 14

Across 7 paths, the API surfaces 14 operations — 3 DELETE, 5 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Shop ShippingProfile 14
GET
/v3/application/shipping-carriers
Etsy Get Shipping Carriers
getShippingCarriers 1 param → 200400500
POST
/v3/application/shops/{shop_id}/shipping-profiles
Etsy Create Shop Shipping Profile
createShopShippingProfile 1 param body → 200403400401500
GET
/v3/application/shops/{shop_id}/shipping-profiles
Etsy Get Shop Shipping Profiles
getShopShippingProfiles 1 param → 200403400500
DELETE
/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
Etsy Delete Shop Shipping Profile
deleteShopShippingProfile 2 params → 403404204400401500
GET
/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
Etsy Get Shop Shipping Profile
getShopShippingProfile 2 params → 200403404400401500
PUT
/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
Etsy Update Shop Shipping Profile
updateShopShippingProfile 2 params body → 200404403400401503500
POST
/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations
Etsy Create Shop Shipping Profile Destination
createShopShippingProfileDestination 2 params body → 201400403401500
GET
/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations
Etsy Get Shop Shipping Profile Destinations by Shipping Profile
getShopShippingProfileDestinationsByShippingProfile 4 params → 200403400404401500
DELETE
/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}
Etsy Delete Shop Shipping Profile Destination
deleteShopShippingProfileDestination 3 params → 204403404400401500
PUT
/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}
Etsy Update Shop Shipping Profile Destination
updateShopShippingProfileDestination 3 params body → 200400403404401503500
POST
/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades
Etsy Create Shop Shipping Profile Upgrade
createShopShippingProfileUpgrade 2 params body → 200400403404401500
GET
/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades
Etsy Get Shop Shipping Profile Upgrades
getShopShippingProfileUpgrades 2 params → 200400403404401500
DELETE
/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}
Etsy Delete Shop Shipping Profile Upgrade
deleteShopShippingProfileUpgrade 3 params → 204403404400401500
PUT
/v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}
Etsy Update Shop Shipping Profile Upgrade
updateShopShippingProfileUpgrade 3 params body → 200400403404401503500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ShopShippingProfileUpgrade (12 properties), ShopShippingProfile (11 properties), ShopShippingProfileDestination (11 properties), ShippingCarrier (4 properties). Each schema is shown below with its type and property counts.

ShopShippingProfileUpgrades
object
A list of shipping upgrade options.
2 properties
ErrorSchema
object
1 property 1 required
ShippingCarrier
object
A supported shipping carrier, which is used to calculate an Estimated Delivery Date.
4 properties
ShopShippingProfileDestination
object
Represents a shipping destination assigned to a shipping profile.
11 properties
ShopShippingProfile
object
Represents a profile used to set a listing's shipping information. Please note that it's not possible to create calculated shipping templates via the API. Howe…
11 properties
ShopShippingProfiles
object
Represents several ShopShippingProfiles.
2 properties
ShippingCarriers
object
Represents several ShippingCarriers.
2 properties
Money
object
A representation of an amount of money.
3 properties
ShopShippingProfileDestinations
object
Represents a list of shipping destination objects.
2 properties
ShippingCarrierMailClass
object
A shipping carrier's mail class, which is used to calculate an Estimated Delivery Date.
2 properties
ShopShippingProfileUpgrade
object
A representation of a shipping profile upgrade option.
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

etsy-shop-shippingprofile-api-openapi.yml Raw ↑

Other APIs Etsy publishes across the network.

Etsy Open API v3 Webhooks
Etsy BuyerTaxonomy API
Etsy Ledger Entry API
Etsy Other API
Etsy Payment API
Etsy Review API
Etsy SellerTaxonomy API
Etsy Shop API
Etsy Shop HolidayPreferences API
Etsy Shop ProcessingProfiles API
Etsy Shop ProductionPartner API
Etsy Shop Receipt API