Go API client for buybrowse

The Browse API has the following resources:

• item_summary:
  Allows shoppers to search for specific items by keyword, GTIN, category, charity, product, image, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values, or UI parameters.
• item:
  Allows shoppers to retrieve the details of a specific item or all items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
  
  This resource also provides a bridge between the eBay legacy APIs, such as the <a href="/api-docs/user-guides/static/finding-user-guide-landing.html" target="_blank">Finding, and the RESTful APIs, which use different formats for the item IDs.

The item_summary, search_by_image, and item resource calls require an <a href="/api-docs/static/oauth-client-credentials-grant.html" target="_blank">Application access token.

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: v1.19.9
• Package version: 1.0.0
• Generator version: 7.9.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 buybrowse "github.com/GIT_USER_ID/GIT_REPO_ID"

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 buybrowse.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), buybrowse.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 buybrowse.ContextOperationServerIndices and buybrowse.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://api.ebay.com/buy/browse/v1

Class	Method	HTTP request	Description
ItemAPI	CheckCompatibility	Post /item/{item_id}/check_compatibility
ItemAPI	GetItem	Get /item/{item_id}
ItemAPI	GetItemByLegacyId	Get /item/get_item_by_legacy_id
ItemAPI	GetItems	Get /item/
ItemAPI	GetItemsByItemGroup	Get /item/get_items_by_item_group
ItemSummaryAPI	Search	Get /item_summary/search
ItemSummaryAPI	SearchByImage	Post /item_summary/search_by_image

Documentation For Models

• AdditionalProductIdentity
• AddonService
• Address
• Amount
• Aspect
• AspectDistribution
• AspectGroup
• AspectValueDistribution
• AttributeNameValue
• AuthenticityGuaranteeProgram
• AuthenticityVerificationProgram
• AutoCorrections
• AvailableCoupon
• BuyingOptionDistribution
• Category
• CategoryDistribution
• CommonDescriptions
• CompanyAddress
• CompatibilityPayload
• CompatibilityProperty
• CompatibilityResponse
• ConditionDescriptor
• ConditionDescriptorValue
• ConditionDistribution
• ConvertedAmount
• CoreItem
• CouponConstraint
• EconomicOperator
• Error
• ErrorParameter
• EstimatedAvailability
• HazardPictogram
• HazardStatement
• HazardousMaterialsLabels
• Image
• Item
• ItemGroup
• ItemGroupSummary
• ItemLocationImpl
• ItemReturnTerms
• ItemSummary
• Items
• LegalAddress
• MarketingPrice
• PaymentMethod
• PaymentMethodBrand
• PickupOptionSummary
• Product
• ProductIdentity
• ProductSafetyLabelPictogram
• ProductSafetyLabelStatement
• ProductSafetyLabels
• RatingHistogram
• Refinement
• Region
• ResponsiblePerson
• ReviewRating
• SearchByImageRequest
• SearchPagedCollection
• Seller
• SellerCustomPolicy
• SellerDetail
• SellerLegalInfo
• ShipToLocation
• ShipToLocations
• ShipToRegion
• ShippingOption
• ShippingOptionSummary
• TargetLocation
• TaxJurisdiction
• Taxes
• TimeDuration
• TypedNameValue
• VatDetail

Documentation For Authorization

Authentication schemes defined for the API:

api_auth

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• https://api.ebay.com/oauth/api_scope/buy.item.bulk: Retrieve eBay items in bulk.
• https://api.ebay.com/oauth/api_scope: View public data from eBay

Example

auth := context.WithValue(context.Background(), buybrowse.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, buybrowse.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