SwaggerClient-php

Etsy's Open API provides a simple RESTful interface for various Etsy.com features. The API endpoints are meant to replace Etsy's Open API v2, which is scheduled to end service in 2022.

All of the endpoints are callable and the majority of the API endpoints are now in a beta phase. This means we do not expect to make any breaking changes before our general release. A handful of endpoints are currently interface stubs (labeled “Feedback Only”) and returns a \"501 Not Implemented\" response code when called.

If you'd like to report an issue or provide feedback on the API design, please add an issue in Github.

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

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 3.0.0
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
"repositories": [
{
"type": "git",
"url": "https://github.com/git_user_id/git_repo_id.git"
}
],
"require": {
"git_user_id/git_repo_id": "*@dev"
}
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?phprequire_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');$apiInstance = newSwagger\Client\Api\BuyerTaxonomyApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.// This is optional, `GuzzleHttp\Client` will be used as default.newGuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->getBuyerTaxonomyNodes();
print_r($result);
} catch (Exception$e) {
echo'Exception when calling BuyerTaxonomyApi->getBuyerTaxonomyNodes: ', $e->getMessage(), PHP_EOL;
}
// Configure API key authorization: api_key$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');$apiInstance = newSwagger\Client\Api\BuyerTaxonomyApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.// This is optional, `GuzzleHttp\Client` will be used as default.newGuzzleHttp\Client(),
$config
);
$taxonomy_id = 56; // int | The unique numeric ID of an Etsy taxonomy node, which is a metadata category for listings organized into the seller taxonomy hierarchy tree. For example, the \"shoes\" taxonomy node (ID: 1429, level: 1) is higher in the hierarchy than \"girls' shoes\" (ID: 1440, level: 2). The taxonomy nodes assigned to a listing support access to specific standardized product scales and properties. For example, listings assigned the taxonomy nodes \"shoes\" or \"girls' shoes\" support access to the \"EU\" shoe size scale with its associated property names and IDs for EU shoe sizes, such as property `value_id`:\"1394\", and `name`:\"38\".try {
$result = $apiInstance->getPropertiesByBuyerTaxonomyId($taxonomy_id);
print_r($result);
} catch (Exception$e) {
echo'Exception when calling BuyerTaxonomyApi->getPropertiesByBuyerTaxonomyId: ', $e->getMessage(), PHP_EOL;
}
?>

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}
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

• AllOfBuyerTaxonomyNodeChildrenItems
• AllOfBuyerTaxonomyNodePropertiesResultsItems
• AllOfBuyerTaxonomyNodePropertyPossibleValuesItems
• AllOfBuyerTaxonomyNodePropertyScalesItems
• AllOfBuyerTaxonomyNodePropertySelectedValuesItems
• AllOfBuyerTaxonomyNodesResultsItems
• AllOfListingImagesResultsItems
• AllOfListingInventoryProductOfferingPrice
• AllOfListingInventoryProductOfferingsItems
• AllOfListingInventoryProductPropertyValuesItems
• AllOfListingInventoryProductsItems
• AllOfListingInventoryWithAssociationsListing
• AllOfListingInventoryWithAssociationsProductsItems
• AllOfListingPropertyValuesResultsItems
• AllOfListingReviewsResultsItems
• AllOfListingVariationImagesResultsItems
• AllOfListingVideosResultsItems
• AllOfPaymentAccountLedgerEntriesResultsItems
• AllOfPaymentAccountLedgerEntryPaymentAdjustmentsItems
• AllOfPaymentAdjustedFees
• AllOfPaymentAdjustedGross
• AllOfPaymentAdjustedNet
• AllOfPaymentAdjustmentPaymentAdjustmentItemsItems
• AllOfPaymentAmountFees
• AllOfPaymentAmountGross
• AllOfPaymentAmountNet
• AllOfPaymentPaymentAdjustmentsItems
• AllOfPaymentPostedFees
• AllOfPaymentPostedGross
• AllOfPaymentPostedNet
• AllOfPaymentsResultsItems
• AllOfSellerTaxonomyNodeChildrenItems
• AllOfSellerTaxonomyNodesResultsItems
• AllOfShippingCarrierDomesticClassesItems
• AllOfShippingCarrierInternationalClassesItems
• AllOfShippingCarriersResultsItems
• AllOfShopListingFilesResultsItems
• AllOfShopListingPrice
• AllOfShopListingWithAssociationsImagesItems
• AllOfShopListingWithAssociationsInventory
• AllOfShopListingWithAssociationsPrice
• AllOfShopListingWithAssociationsProductionPartnersItems
• AllOfShopListingWithAssociationsShippingProfile
• AllOfShopListingWithAssociationsShop
• AllOfShopListingWithAssociationsTranslationsItems
• AllOfShopListingWithAssociationsUser
• AllOfShopListingWithAssociationsVideosItems
• AllOfShopListingsResultsItems
• AllOfShopListingsWithAssociationsResultsItems
• AllOfShopProductionPartnersResultsItems
• AllOfShopReceiptDiscountAmt
• AllOfShopReceiptGiftWrapPrice
• AllOfShopReceiptGrandtotal
• AllOfShopReceiptRefundsItems
• AllOfShopReceiptShipmentsItems
• AllOfShopReceiptSubtotal
• AllOfShopReceiptTotalPrice
• AllOfShopReceiptTotalShippingCost
• AllOfShopReceiptTotalTaxCost
• AllOfShopReceiptTotalVatCost
• AllOfShopReceiptTransactionPrice
• AllOfShopReceiptTransactionProductDataItems
• AllOfShopReceiptTransactionShippingCost
• AllOfShopReceiptTransactionVariationsItems
• AllOfShopReceiptTransactionsItems
• AllOfShopReceiptTransactionsResultsItems
• AllOfShopReceiptsResultsItems
• AllOfShopRefundAmount
• AllOfShopReturnPoliciesResultsItems
• AllOfShopSectionsResultsItems
• AllOfShopShippingProfileDestinationPrimaryCost
• AllOfShopShippingProfileDestinationSecondaryCost
• AllOfShopShippingProfileDestinationsResultsItems
• AllOfShopShippingProfileShippingProfileDestinationsItems
• AllOfShopShippingProfileShippingProfileUpgradesItems
• AllOfShopShippingProfileUpgradePrice
• AllOfShopShippingProfileUpgradeSecondaryPrice
• AllOfShopShippingProfileUpgradesResultsItems
• AllOfShopShippingProfilesResultsItems
• AllOfShopsResultsItems
• AllOfTaxonomyNodePropertiesResultsItems
• AllOfTaxonomyNodePropertyPossibleValuesItems
• AllOfTaxonomyNodePropertyScalesItems
• AllOfTaxonomyNodePropertySelectedValuesItems
• AllOfTransactionReviewsResultsItems
• AllOfUserAddressesResultsItems
• ApplicationScopesBody
• BuyerTaxonomyNode
• BuyerTaxonomyNodeProperties
• BuyerTaxonomyNodeProperty
• BuyerTaxonomyNodes
• BuyerTaxonomyPropertyScale
• BuyerTaxonomyPropertyValue
• DestinationsShippingProfileDestinationIdBody
• ErrorSchema
• ListingIdFilesBody
• ListingIdImagesBody
• ListingIdInventoryBody
• ListingIdVariationimagesBody
• ListingIdVideosBody
• ListingImage
• ListingImages
• ListingInventory
• ListingInventoryProduct
• ListingInventoryProductOffering
• ListingInventoryWithAssociations
• ListingPropertyValue
• ListingPropertyValues
• ListingReview
• ListingReviews
• ListingTranslation
• ListingVariationImage
• ListingVariationImages
• ListingVideo
• ListingVideos
• ListingsListingIdBody
• ListingsListingIdBody1
• Money
• Payment
• PaymentAccountLedgerEntries
• PaymentAccountLedgerEntry
• PaymentAdjustment
• PaymentAdjustmentItem
• Payments
• PoliciesReturnBody
• Pong
• PropertiesPropertyIdBody
• ReceiptIdTrackingBody
• ReceiptsReceiptIdBody
• ReturnConsolidateBody
• ReturnReturnPolicyIdBody
• Scopes
• SectionsShopSectionIdBody
• Self
• SellerTaxonomyNode
• SellerTaxonomyNodes
• ShippingCarrier
• ShippingCarrierMailClass
• ShippingCarriers
• ShippingProfileIdDestinationsBody
• ShippingProfileIdUpgradesBody
• ShippingprofilesShippingProfileIdBody
• Shop
• ShopIdListingsBody
• ShopIdSectionsBody
• ShopIdShippingprofilesBody
• ShopListing
• ShopListingFile
• ShopListingFiles
• ShopListingWithAssociations
• ShopListings
• ShopListingsWithAssociations
• ShopProductionPartner
• ShopProductionPartners
• ShopReceipt
• ShopReceiptShipment
• ShopReceiptTransaction
• ShopReceiptTransactions
• ShopReceipts
• ShopRefund
• ShopReturnPolicies
• ShopReturnPolicy
• ShopSection
• ShopSections
• ShopShippingProfile
• ShopShippingProfileDestination
• ShopShippingProfileDestinations
• ShopShippingProfileUpgrade
• ShopShippingProfileUpgrades
• ShopShippingProfiles
• Shops
• ShopsShopIdBody
• TaxonomyNodeProperties
• TaxonomyNodeProperty
• TaxonomyPropertyScale
• TaxonomyPropertyValue
• TransactionReview
• TransactionReviews
• TransactionVariations
• TranslationsLanguageBody
• TranslationsLanguageBody1
• UpgradesUpgradeIdBody
• User
• UserAddress
• UserAddresses
• V3applicationlistingslistingIdinventoryOfferings
• V3applicationlistingslistingIdinventoryProducts
• V3applicationlistingslistingIdinventoryPropertyValues
• V3applicationshopsshopIdlistingslistingIdvariationimagesVariationImages

Documentation For Authorization

api_key

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

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 member's email address
• 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

Author

developers@etsy.com