Go API client for goEtsy

© 2021-2024 Etsy, Inc. All Rights Reserved. Use of this code is subject to Etsy's API Developer Terms of Use.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 3.0.0
• Package version: 1.0.0
• Build date: 2025-02-20T21:58:10.698549923+07:00[Asia/Saigon]
• Generator version: 7.8.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import goEtsy "github.com/gearment/go-etsy/client"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value goEtsy.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), goEtsy.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value goEtsy.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), goEtsy.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using goEtsy.ContextOperationServerIndices and goEtsy.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), goEtsy.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), goEtsy.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://openapi.etsy.com

Class	Method	HTTP request	Description
BuyerTaxonomyAPI	GetBuyerTaxonomyNodes	Get /v3/application/buyer-taxonomy/nodes
BuyerTaxonomyAPI	GetPropertiesByBuyerTaxonomyId	Get /v3/application/buyer-taxonomy/nodes/{taxonomy_id}/properties
LedgerEntryAPI	GetShopPaymentAccountLedgerEntries	Get /v3/application/shops/{shop_id}/payment-account/ledger-entries
LedgerEntryAPI	GetShopPaymentAccountLedgerEntry	Get /v3/application/shops/{shop_id}/payment-account/ledger-entries/{ledger_entry_id}
OtherAPI	Ping	Get /v3/application/openapi-ping
OtherAPI	TokenScopes	Post /v3/application/scopes
PaymentAPI	GetPaymentAccountLedgerEntryPayments	Get /v3/application/shops/{shop_id}/payment-account/ledger-entries/payments
PaymentAPI	GetPayments	Get /v3/application/shops/{shop_id}/payments
PaymentAPI	GetShopPaymentByReceiptId	Get /v3/application/shops/{shop_id}/receipts/{receipt_id}/payments
ReviewAPI	GetReviewsByListing	Get /v3/application/listings/{listing_id}/reviews
ReviewAPI	GetReviewsByShop	Get /v3/application/shops/{shop_id}/reviews
SellerTaxonomyAPI	GetPropertiesByTaxonomyId	Get /v3/application/seller-taxonomy/nodes/{taxonomy_id}/properties
SellerTaxonomyAPI	GetSellerTaxonomyNodes	Get /v3/application/seller-taxonomy/nodes
ShopAPI	FindShops	Get /v3/application/shops
ShopAPI	GetShop	Get /v3/application/shops/{shop_id}
ShopAPI	GetShopByOwnerUserId	Get /v3/application/users/{user_id}/shops
ShopAPI	UpdateShop	Put /v3/application/shops/{shop_id}
ShopHolidayPreferencesAPI	GetHolidayPreferences	Get /v3/application/shops/{shop_id}/holiday-preferences
ShopHolidayPreferencesAPI	UpdateHolidayPreferences	Put /v3/application/shops/{shop_id}/holiday-preferences/{holiday_id}
ShopListingAPI	CreateDraftListing	Post /v3/application/shops/{shop_id}/listings
ShopListingAPI	DeleteListing	Delete /v3/application/listings/{listing_id}
ShopListingAPI	DeleteListingProperty	Delete /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}
ShopListingAPI	FindAllActiveListingsByShop	Get /v3/application/shops/{shop_id}/listings/active
ShopListingAPI	FindAllListingsActive	Get /v3/application/listings/active
ShopListingAPI	GetFeaturedListingsByShop	Get /v3/application/shops/{shop_id}/listings/featured
ShopListingAPI	GetListing	Get /v3/application/listings/{listing_id}
ShopListingAPI	GetListingProperties	Get /v3/application/shops/{shop_id}/listings/{listing_id}/properties
ShopListingAPI	GetListingProperty	Get /v3/application/listings/{listing_id}/properties/{property_id}
ShopListingAPI	GetListingsByListingIds	Get /v3/application/listings/batch
ShopListingAPI	GetListingsByShop	Get /v3/application/shops/{shop_id}/listings
ShopListingAPI	GetListingsByShopReceipt	Get /v3/application/shops/{shop_id}/receipts/{receipt_id}/listings
ShopListingAPI	GetListingsByShopReturnPolicy	Get /v3/application/shops/{shop_id}/policies/return/{return_policy_id}/listings
ShopListingAPI	GetListingsByShopSectionId	Get /v3/application/shops/{shop_id}/shop-sections/listings
ShopListingAPI	UpdateListing	Patch /v3/application/shops/{shop_id}/listings/{listing_id}
ShopListingAPI	UpdateListingDeprecated	Put /v3/application/shops/{shop_id}/listings/{listing_id}
ShopListingAPI	UpdateListingProperty	Put /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}
ShopListingFileAPI	DeleteListingFile	Delete /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}
ShopListingFileAPI	GetAllListingFiles	Get /v3/application/shops/{shop_id}/listings/{listing_id}/files
ShopListingFileAPI	GetListingFile	Get /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}
ShopListingFileAPI	UploadListingFile	Post /v3/application/shops/{shop_id}/listings/{listing_id}/files
ShopListingImageAPI	DeleteListingImage	Delete /v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}
ShopListingImageAPI	GetListingImage	Get /v3/application/listings/{listing_id}/images/{listing_image_id}
ShopListingImageAPI	GetListingImageDeprecated	Get /v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}
ShopListingImageAPI	GetListingImages	Get /v3/application/listings/{listing_id}/images
ShopListingImageAPI	GetListingImagesDeprecated	Get /v3/application/shops/{shop_id}/listings/{listing_id}/images
ShopListingImageAPI	UploadListingImage	Post /v3/application/shops/{shop_id}/listings/{listing_id}/images
ShopListingInventoryAPI	GetListingInventory	Get /v3/application/listings/{listing_id}/inventory
ShopListingInventoryAPI	UpdateListingInventory	Put /v3/application/listings/{listing_id}/inventory
ShopListingOfferingAPI	GetListingOffering	Get /v3/application/listings/{listing_id}/products/{product_id}/offerings/{product_offering_id}
ShopListingProductAPI	GetListingProduct	Get /v3/application/listings/{listing_id}/inventory/products/{product_id}
ShopListingTranslationAPI	CreateListingTranslation	Post /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}
ShopListingTranslationAPI	GetListingTranslation	Get /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}
ShopListingTranslationAPI	UpdateListingTranslation	Put /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}
ShopListingVariationImageAPI	GetListingVariationImages	Get /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images
ShopListingVariationImageAPI	UpdateVariationImages	Post /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images
ShopListingVideoAPI	DeleteListingVideo	Delete /v3/application/shops/{shop_id}/listings/{listing_id}/videos/{video_id}
ShopListingVideoAPI	GetListingVideo	Get /v3/application/listings/{listing_id}/videos/{video_id}
ShopListingVideoAPI	GetListingVideos	Get /v3/application/listings/{listing_id}/videos
ShopListingVideoAPI	UploadListingVideo	Post /v3/application/shops/{shop_id}/listings/{listing_id}/videos
ShopProductionPartnerAPI	GetShopProductionPartners	Get /v3/application/shops/{shop_id}/production-partners
ShopReceiptAPI	CreateReceiptShipment	Post /v3/application/shops/{shop_id}/receipts/{receipt_id}/tracking
ShopReceiptAPI	GetShopReceipt	Get /v3/application/shops/{shop_id}/receipts/{receipt_id}
ShopReceiptAPI	GetShopReceipts	Get /v3/application/shops/{shop_id}/receipts
ShopReceiptAPI	UpdateShopReceipt	Put /v3/application/shops/{shop_id}/receipts/{receipt_id}
ShopReceiptTransactionsAPI	GetShopReceiptTransaction	Get /v3/application/shops/{shop_id}/transactions/{transaction_id}
ShopReceiptTransactionsAPI	GetShopReceiptTransactionsByListing	Get /v3/application/shops/{shop_id}/listings/{listing_id}/transactions
ShopReceiptTransactionsAPI	GetShopReceiptTransactionsByReceipt	Get /v3/application/shops/{shop_id}/receipts/{receipt_id}/transactions
ShopReceiptTransactionsAPI	GetShopReceiptTransactionsByShop	Get /v3/application/shops/{shop_id}/transactions
ShopReturnPolicyAPI	ConsolidateShopReturnPolicies	Post /v3/application/shops/{shop_id}/policies/return/consolidate
ShopReturnPolicyAPI	CreateShopReturnPolicy	Post /v3/application/shops/{shop_id}/policies/return
ShopReturnPolicyAPI	DeleteShopReturnPolicy	Delete /v3/application/shops/{shop_id}/policies/return/{return_policy_id}
ShopReturnPolicyAPI	GetShopReturnPolicies	Get /v3/application/shops/{shop_id}/policies/return
ShopReturnPolicyAPI	GetShopReturnPolicy	Get /v3/application/shops/{shop_id}/policies/return/{return_policy_id}
ShopReturnPolicyAPI	UpdateShopReturnPolicy	Put /v3/application/shops/{shop_id}/policies/return/{return_policy_id}
ShopSectionAPI	CreateShopSection	Post /v3/application/shops/{shop_id}/sections
ShopSectionAPI	DeleteShopSection	Delete /v3/application/shops/{shop_id}/sections/{shop_section_id}
ShopSectionAPI	GetShopSection	Get /v3/application/shops/{shop_id}/sections/{shop_section_id}
ShopSectionAPI	GetShopSections	Get /v3/application/shops/{shop_id}/sections
ShopSectionAPI	UpdateShopSection	Put /v3/application/shops/{shop_id}/sections/{shop_section_id}
ShopShippingProfileAPI	CreateShopShippingProfile	Post /v3/application/shops/{shop_id}/shipping-profiles
ShopShippingProfileAPI	CreateShopShippingProfileDestination	Post /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations
ShopShippingProfileAPI	CreateShopShippingProfileUpgrade	Post /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades
ShopShippingProfileAPI	DeleteShopShippingProfile	Delete /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
ShopShippingProfileAPI	DeleteShopShippingProfileDestination	Delete /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}
ShopShippingProfileAPI	DeleteShopShippingProfileUpgrade	Delete /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}
ShopShippingProfileAPI	GetShippingCarriers	Get /v3/application/shipping-carriers
ShopShippingProfileAPI	GetShopShippingProfile	Get /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
ShopShippingProfileAPI	GetShopShippingProfileDestinationsByShippingProfile	Get /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations
ShopShippingProfileAPI	GetShopShippingProfileUpgrades	Get /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades
ShopShippingProfileAPI	GetShopShippingProfiles	Get /v3/application/shops/{shop_id}/shipping-profiles
ShopShippingProfileAPI	UpdateShopShippingProfile	Put /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
ShopShippingProfileAPI	UpdateShopShippingProfileDestination	Put /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}
ShopShippingProfileAPI	UpdateShopShippingProfileUpgrade	Put /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}
UserAPI	GetMe	Get /v3/application/users/me
UserAPI	GetUser	Get /v3/application/users/{user_id}
UserAddressAPI	DeleteUserAddress	Delete /v3/application/user/addresses/{user_address_id}
UserAddressAPI	GetUserAddress	Get /v3/application/user/addresses/{user_address_id}
UserAddressAPI	GetUserAddresses	Get /v3/application/user/addresses

Documentation For Models

• BuyerTaxonomyNode
• BuyerTaxonomyNodeProperties
• BuyerTaxonomyNodeProperty
• BuyerTaxonomyNodes
• BuyerTaxonomyPropertyScale
• BuyerTaxonomyPropertyValue
• CreateDraftListingRequestItemDimensionsUnit
• CreateDraftListingRequestItemWeightUnit
• CreateDraftListingRequestType
• CreateDraftListingRequestWhenMade
• CreateDraftListingRequestWhoMade
• CreateShopShippingProfileRequestDestinationRegion
• CreateShopShippingProfileRequestProcessingTimeUnit
• CreateShopShippingProfileUpgradeRequestType
• ErrorSchema
• GetListingInventoryIncludesParameter
• GetListingsByShopIncludesParameterInner
• GetListingsByShopSortOnParameter
• GetListingsByShopSortOrderParameter
• GetListingsByShopStateParameter
• GetShopReceiptsSortOnParameter
• GetShopReceiptsSortOrderParameter
• ListingImage
• ListingImages
• ListingInventory
• ListingInventoryProduct
• ListingInventoryProductOffering
• ListingInventoryWithAssociations
• ListingPropertyValue
• ListingPropertyValues
• ListingReview
• ListingReviews
• ListingTranslation
• ListingTranslations
• ListingVariationImage
• ListingVariationImages
• ListingVideo
• ListingVideoVideoState
• ListingVideos
• Money
• Payment
• PaymentAccountLedgerEntries
• PaymentAccountLedgerEntry
• PaymentAdjustment
• PaymentAdjustmentItem
• Payments
• Pong
• Self
• SellerTaxonomyNode
• SellerTaxonomyNodes
• ShippingCarrier
• ShippingCarrierMailClass
• ShippingCarriers
• Shop
• ShopHolidayPreference
• ShopListing
• ShopListingFile
• ShopListingFiles
• ShopListingState
• ShopListingWhenMade
• ShopListingWhoMade
• ShopListingWithAssociations
• ShopListings
• ShopListingsWithAssociations
• ShopProductionPartner
• ShopProductionPartners
• ShopReceipt
• ShopReceiptShipment
• ShopReceiptStatus
• ShopReceiptTransaction
• ShopReceiptTransactions
• ShopReceipts
• ShopRefund
• ShopReturnPolicies
• ShopReturnPolicy
• ShopSection
• ShopSections
• ShopShippingProfile
• ShopShippingProfileDestination
• ShopShippingProfileDestinationDestinationRegion
• ShopShippingProfileDestinations
• ShopShippingProfileProfileType
• ShopShippingProfileUpgrade
• ShopShippingProfileUpgrades
• ShopShippingProfiles
• Shops
• TaxonomyNodeProperties
• TaxonomyNodeProperty
• TaxonomyPropertyScale
• TaxonomyPropertyValue
• TransactionReview
• TransactionReviews
• TransactionVariations
• TypeDiscriminator
• UpdateHolidayPreferencesHolidayIdParameter
• UpdateListingDeprecatedRequestState
• UpdateListingDeprecatedRequestType
• UpdateListingInventoryRequest
• UpdateListingInventoryRequestProductsInner
• UpdateListingInventoryRequestProductsInnerOfferingsInner
• UpdateListingInventoryRequestProductsInnerPropertyValuesInner
• UpdateListingRequestItemDimensionsUnit
• UpdateListingRequestItemWeightUnit
• UpdateVariationImagesRequest
• UpdateVariationImagesRequestVariationImagesInner
• User
• UserAddress
• UserAddresses

Documentation For Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: x-api-key and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		goEtsy.ContextAPIKeys,
		map[string]goEtsy.APIKey{
			"x-api-key": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://www.etsy.com/oauth/connect
• Scopes:
• address_r: see billing and shipping addresses
• address_w: update billing and shipping addresses
• billing_r: see all billing statement data
• cart_r: read shopping carts
• cart_w: add/remove from shopping carts
• email_r: read a user profile
• favorites_r: see private favorites
• favorites_w: add/remove favorites
• feedback_r: see purchase info in feedback
• listings_d: delete listings
• listings_r: see all listings (including expired etc)
• listings_w: create/edit listings
• profile_r: see all profile data
• profile_w: update user profile, avatar, etc
• recommend_r: see recommended listings
• recommend_w: accept/reject recommended listings
• shops_r: see private shop info
• shops_w: update shop
• transactions_r: see all checkout/payment data
• transactions_w: update receipts

Example

auth := context.WithValue(context.Background(), goEtsy.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, goEtsy.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

[email protected]