swagger

package

v0.0.0-...-c324a2f Latest Latest Go to latest Published: May 6, 2023 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/skeleton1231/amz-sp-api-gosdk

Links

Open Source Insights

README ¶

Go API client for swagger

The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the Catalog Items API Use Case Guide.

Overview

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

API version: 2022-04-01
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://sellercentral.amazon.com/gp/mws/contactus.html

Installation

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

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://sellingpartnerapi-na.amazon.com/

Class	Method	HTTP request	Description
CatalogApi	GetCatalogItem	Get /catalog/2022-04-01/items/{asin}
CatalogApi	SearchCatalogItems	Get /catalog/2022-04-01/items

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* Selling Partner API for Catalog Items * * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2022-04-01-use-case-guide). * * API version: 2022-04-01 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type BasicAuth
type BrandRefinement
type CatalogApiGetCatalogItemOpts
type CatalogApiSearchCatalogItemsOpts
type CatalogApiService
- func (a *CatalogApiService) GetCatalogItem(ctx context.Context, asin string, marketplaceIds []string, ...) (Item, *http.Response, error)
- func (a *CatalogApiService) SearchCatalogItems(ctx context.Context, marketplaceIds []string, ...) (ItemSearchResults, *http.Response, error)
type ClassificationRefinement
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type Dimension
type Dimensions
type ErrorList
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type Item
type ItemBrowseClassification
type ItemClassificationSalesRank
type ItemContributor
type ItemContributorRole
type ItemDimensionsByMarketplace
type ItemDisplayGroupSalesRank
type ItemIdentifier
type ItemIdentifiersByMarketplace
type ItemImage
type ItemImagesByMarketplace
type ItemProductTypeByMarketplace
type ItemRelationship
type ItemRelationshipsByMarketplace
type ItemSalesRanksByMarketplace
type ItemSearchResults
type ItemSummaryByMarketplace
type ItemVariationTheme
type ItemVendorDetailsByMarketplace
type ItemVendorDetailsCategory
type ModelError
type ModelMap
type Pagination
type Refinements

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	CatalogApi *CatalogApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner API for Catalog Items API v2022-04-01 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BrandRefinement ¶

type BrandRefinement struct {
	// The estimated number of results that would still be returned if refinement key applied.
	NumberOfResults int32 `json:"numberOfResults"`
	// Brand name. For display and can be used as a search refinement.
	BrandName string `json:"brandName"`
}

Description of a brand that can be used to get more fine-grained search results.

type CatalogApiGetCatalogItemOpts ¶

type CatalogApiGetCatalogItemOpts struct {
	IncludedData optional.Interface
	Locale       optional.String
}

type CatalogApiSearchCatalogItemsOpts ¶

type CatalogApiSearchCatalogItemsOpts struct {
	Identifiers       optional.Interface
	IdentifiersType   optional.String
	IncludedData      optional.Interface
	Locale            optional.String
	SellerId          optional.String
	Keywords          optional.Interface
	BrandNames        optional.Interface
	ClassificationIds optional.Interface
	PageSize          optional.Int32
	PageToken         optional.String
	KeywordsLocale    optional.String
}

type CatalogApiService ¶

type CatalogApiService service

func (*CatalogApiService) GetCatalogItem ¶

func (a *CatalogApiService) GetCatalogItem(ctx context.Context, asin string, marketplaceIds []string, localVarOptionals *CatalogApiGetCatalogItemOpts) (Item, *http.Response, error)

func (*CatalogApiService) SearchCatalogItems ¶

func (a *CatalogApiService) SearchCatalogItems(ctx context.Context, marketplaceIds []string, localVarOptionals *CatalogApiSearchCatalogItemsOpts) (ItemSearchResults, *http.Response, error)

type ClassificationRefinement ¶

type ClassificationRefinement struct {
	// The estimated number of results that would still be returned if refinement key applied.
	NumberOfResults int32 `json:"numberOfResults"`
	// Display name for the classification.
	DisplayName string `json:"displayName"`
	// Identifier for the classification that can be used for search refinement purposes.
	ClassificationId string `json:"classificationId"`
}

Description of a classification that can be used to get more fine-grained search results.

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type Dimension ¶

type Dimension struct {
	// Measurement unit of the dimension value.
	Unit string `json:"unit,omitempty"`
	// Numeric dimension value.
	Value float64 `json:"value,omitempty"`
}

Individual dimension value of an Amazon catalog item or item package.

type Dimensions ¶

type Dimensions struct {
	Height *Dimension `json:"height,omitempty"`
	Length *Dimension `json:"length,omitempty"`
	Weight *Dimension `json:"weight,omitempty"`
	Width  *Dimension `json:"width,omitempty"`
}

Dimensions of an Amazon catalog item or item in its packaging.

type ErrorList ¶

type ErrorList struct {
	Errors []ModelError `json:"errors"`
}

A list of error responses returned when a request is unsuccessful.

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type Item ¶

type Item struct {
	Asin          string                            `json:"asin"`
	Attributes    *ModelMap                         `json:"attributes,omitempty"`
	Dimensions    *[]ItemDimensionsByMarketplace    `json:"dimensions,omitempty"`
	Identifiers   *[]ItemIdentifiersByMarketplace   `json:"identifiers,omitempty"`
	Images        *[]ItemImagesByMarketplace        `json:"images,omitempty"`
	ProductTypes  *[]ItemProductTypeByMarketplace   `json:"productTypes,omitempty"`
	Relationships *[]ItemRelationshipsByMarketplace `json:"relationships,omitempty"`
	SalesRanks    *[]ItemSalesRanksByMarketplace    `json:"salesRanks,omitempty"`
	Summaries     *[]ItemSummaryByMarketplace       `json:"summaries,omitempty"`
	VendorDetails *[]ItemVendorDetailsByMarketplace `json:"vendorDetails,omitempty"`
}

An item in the Amazon catalog.

type ItemBrowseClassification ¶

type ItemBrowseClassification struct {
	// Display name for the classification.
	DisplayName string `json:"displayName"`
	// Identifier of the classification (browse node identifier).
	ClassificationId string `json:"classificationId"`
}

Classification (browse node) associated with an Amazon catalog item.

type ItemClassificationSalesRank ¶

type ItemClassificationSalesRank struct {
	// Identifier of the classification associated with the sales rank.
	ClassificationId string `json:"classificationId"`
	// Title, or name, of the sales rank.
	Title string `json:"title"`
	// Corresponding Amazon retail website link, or URL, for the sales rank.
	Link string `json:"link,omitempty"`
	// Sales rank value.
	Rank int32 `json:"rank"`
}

Sales rank of an Amazon catalog item by classification.

type ItemContributor ¶

type ItemContributor struct {
	Role *ItemContributorRole `json:"role"`
	// Name of the contributor, such as Jane Austen.
	Value string `json:"value"`
}

Individual contributor to the creation of an item, such as an author or actor.

type ItemContributorRole ¶

type ItemContributorRole struct {
	// Display name of the role in the requested locale, such as Author or Actor.
	DisplayName string `json:"displayName,omitempty"`
	// Role value for the Amazon catalog item, such as author or actor.
	Value string `json:"value"`
}

Role of an individual contributor in the creation of an item, such as author or actor.

type ItemDimensionsByMarketplace ¶

type ItemDimensionsByMarketplace struct {
	// Amazon marketplace identifier.
	MarketplaceId string      `json:"marketplaceId"`
	Item          *Dimensions `json:"item,omitempty"`
	Package_      *Dimensions `json:"package,omitempty"`
}

Dimensions associated with the item in the Amazon catalog for the indicated Amazon marketplace.

type ItemDisplayGroupSalesRank ¶

type ItemDisplayGroupSalesRank struct {
	// Name of the website display group associated with the sales rank
	WebsiteDisplayGroup string `json:"websiteDisplayGroup"`
	// Title, or name, of the sales rank.
	Title string `json:"title"`
	// Corresponding Amazon retail website link, or URL, for the sales rank.
	Link string `json:"link,omitempty"`
	// Sales rank value.
	Rank int32 `json:"rank"`
}

Sales rank of an Amazon catalog item by website display group.

type ItemIdentifier ¶

type ItemIdentifier struct {
	// Type of identifier, such as UPC, EAN, or ISBN.
	IdentifierType string `json:"identifierType"`
	// Identifier.
	Identifier string `json:"identifier"`
}

Identifier associated with the item in the Amazon catalog, such as a UPC or EAN identifier.

type ItemIdentifiersByMarketplace ¶

type ItemIdentifiersByMarketplace struct {
	// Amazon marketplace identifier.
	MarketplaceId string `json:"marketplaceId"`
	// Identifiers associated with the item in the Amazon catalog for the indicated Amazon marketplace.
	Identifiers []ItemIdentifier `json:"identifiers"`
}

Identifiers associated with the item in the Amazon catalog for the indicated Amazon marketplace.

type ItemImage ¶

type ItemImage struct {
	// Variant of the image, such as `MAIN` or `PT01`.
	Variant string `json:"variant"`
	// Link, or URL, for the image.
	Link string `json:"link"`
	// Height of the image in pixels.
	Height int32 `json:"height"`
	// Width of the image in pixels.
	Width int32 `json:"width"`
}

Image for an item in the Amazon catalog.

type ItemImagesByMarketplace ¶

type ItemImagesByMarketplace struct {
	// Amazon marketplace identifier.
	MarketplaceId string `json:"marketplaceId"`
	// Images for an item in the Amazon catalog for the indicated Amazon marketplace.
	Images []ItemImage `json:"images"`
}

Images for an item in the Amazon catalog for the indicated Amazon marketplace.

type ItemProductTypeByMarketplace ¶

type ItemProductTypeByMarketplace struct {
	// Amazon marketplace identifier.
	MarketplaceId string `json:"marketplaceId,omitempty"`
	// Name of the product type associated with the Amazon catalog item.
	ProductType string `json:"productType,omitempty"`
}

Product type associated with the Amazon catalog item for the indicated Amazon marketplace.

type ItemRelationship ¶

type ItemRelationship struct {
	// Identifiers (ASINs) of the related items that are children of this item.
	ChildAsins []string `json:"childAsins,omitempty"`
	// Identifiers (ASINs) of the related items that are parents of this item.
	ParentAsins    []string            `json:"parentAsins,omitempty"`
	VariationTheme *ItemVariationTheme `json:"variationTheme,omitempty"`
	// Type of relationship.
	Type_ string `json:"type"`
}

Relationship details for an Amazon catalog item.

type ItemRelationshipsByMarketplace ¶

type ItemRelationshipsByMarketplace struct {
	// Amazon marketplace identifier.
	MarketplaceId string `json:"marketplaceId"`
	// Relationships for the item.
	Relationships []ItemRelationship `json:"relationships"`
}

Relationship details for the Amazon catalog item for the indicated Amazon marketplace.

type ItemSalesRanksByMarketplace ¶

type ItemSalesRanksByMarketplace struct {
	// Amazon marketplace identifier.
	MarketplaceId string `json:"marketplaceId"`
	// Sales ranks of an Amazon catalog item for an Amazon marketplace by classification.
	ClassificationRanks []ItemClassificationSalesRank `json:"classificationRanks,omitempty"`
	// Sales ranks of an Amazon catalog item for an Amazon marketplace by website display group.
	DisplayGroupRanks []ItemDisplayGroupSalesRank `json:"displayGroupRanks,omitempty"`
}

Sales ranks of an Amazon catalog item for the indicated Amazon marketplace.

type ItemSearchResults ¶

type ItemSearchResults struct {
	// For `identifiers`-based searches, the total number of Amazon catalog items found. For `keywords`-based searches, the estimated total number of Amazon catalog items matched by the search query (only results up to the page count limit will be returned per request regardless of the number found).  Note: The maximum number of items (ASINs) that can be returned and paged through is 1000.
	NumberOfResults int32        `json:"numberOfResults"`
	Pagination      *Pagination  `json:"pagination"`
	Refinements     *Refinements `json:"refinements"`
	// A list of items from the Amazon catalog.
	Items []Item `json:"items"`
}

Items in the Amazon catalog and search related metadata.

type ItemSummaryByMarketplace ¶

type ItemSummaryByMarketplace struct {
	// Amazon marketplace identifier.
	MarketplaceId string `json:"marketplaceId"`
	// Identifies an Amazon catalog item is intended for an adult audience or is sexual in nature.
	AdultProduct bool `json:"adultProduct,omitempty"`
	// Identifies an Amazon catalog item is autographed by a player or celebrity.
	Autographed bool `json:"autographed,omitempty"`
	// Name of the brand associated with an Amazon catalog item.
	Brand                string                    `json:"brand,omitempty"`
	BrowseClassification *ItemBrowseClassification `json:"browseClassification,omitempty"`
	// Name of the color associated with an Amazon catalog item.
	Color string `json:"color,omitempty"`
	// Individual contributors to the creation of an item, such as the authors or actors.
	Contributors []ItemContributor `json:"contributors,omitempty"`
	// Classification type associated with the Amazon catalog item.
	ItemClassification string `json:"itemClassification,omitempty"`
	// Name, or title, associated with an Amazon catalog item.
	ItemName string `json:"itemName,omitempty"`
	// Name of the manufacturer associated with an Amazon catalog item.
	Manufacturer string `json:"manufacturer,omitempty"`
	// Identifies an Amazon catalog item is memorabilia valued for its connection with historical events, culture, or entertainment.
	Memorabilia bool `json:"memorabilia,omitempty"`
	// Model number associated with an Amazon catalog item.
	ModelNumber string `json:"modelNumber,omitempty"`
	// Quantity of an Amazon catalog item in one package.
	PackageQuantity int32 `json:"packageQuantity,omitempty"`
	// Part number associated with an Amazon catalog item.
	PartNumber string `json:"partNumber,omitempty"`
	// First date on which an Amazon catalog item is shippable to customers.
	ReleaseDate string `json:"releaseDate,omitempty"`
	// Name of the size associated with an Amazon catalog item.
	Size string `json:"size,omitempty"`
	// Name of the style associated with an Amazon catalog item.
	Style string `json:"style,omitempty"`
	// Identifies an Amazon catalog item is eligible for trade-in.
	TradeInEligible bool `json:"tradeInEligible,omitempty"`
	// Identifier of the website display group associated with an Amazon catalog item.
	WebsiteDisplayGroup string `json:"websiteDisplayGroup,omitempty"`
	// Display name of the website display group associated with an Amazon catalog item.
	WebsiteDisplayGroupName string `json:"websiteDisplayGroupName,omitempty"`
}

Summary details of an Amazon catalog item for the indicated Amazon marketplace.

type ItemVariationTheme ¶

type ItemVariationTheme struct {
	// Names of the Amazon catalog item attributes associated with the variation theme.
	Attributes []string `json:"attributes,omitempty"`
	// Variation theme indicating the combination of Amazon item catalog attributes that define the variation family.
	Theme string `json:"theme,omitempty"`
}

Variation theme indicating the combination of Amazon item catalog attributes that define the variation family.

type ItemVendorDetailsByMarketplace ¶

type ItemVendorDetailsByMarketplace struct {
	// Amazon marketplace identifier.
	MarketplaceId string `json:"marketplaceId"`
	// Brand code associated with an Amazon catalog item.
	BrandCode string `json:"brandCode,omitempty"`
	// Manufacturer code associated with an Amazon catalog item.
	ManufacturerCode string `json:"manufacturerCode,omitempty"`
	// Parent vendor code of the manufacturer code.
	ManufacturerCodeParent string                     `json:"manufacturerCodeParent,omitempty"`
	ProductCategory        *ItemVendorDetailsCategory `json:"productCategory,omitempty"`
	// Product group associated with an Amazon catalog item.
	ProductGroup       string                     `json:"productGroup,omitempty"`
	ProductSubcategory *ItemVendorDetailsCategory `json:"productSubcategory,omitempty"`
	// Replenishment category associated with an Amazon catalog item.
	ReplenishmentCategory string `json:"replenishmentCategory,omitempty"`
}

Vendor details associated with an Amazon catalog item for the indicated Amazon marketplace.

type ItemVendorDetailsCategory ¶

type ItemVendorDetailsCategory struct {
	// Display name of the product category or subcategory
	DisplayName string `json:"displayName,omitempty"`
	// Value (code) of the product category or subcategory.
	Value string `json:"value,omitempty"`
}

Product category or subcategory associated with an Amazon catalog item.

type ModelError ¶

type ModelError struct {
	// An error code that identifies the type of error that occurred.
	Code string `json:"code"`
	// A message that describes the error condition.
	Message string `json:"message"`
	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`
}

Error response returned when the request is unsuccessful.

type ModelMap ¶

type ModelMap map[string]interface{}

type Pagination struct {
	// A token that can be used to fetch the next page.
	NextToken string `json:"nextToken,omitempty"`
	// A token that can be used to fetch the previous page.
	PreviousToken string `json:"previousToken,omitempty"`
}

When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there will be no `nextToken` key in the pagination object.

type Refinements struct {
	// Brand search refinements.
	Brands []BrandRefinement `json:"brands"`
	// Classification search refinements.
	Classifications []ClassificationRefinement `json:"classifications"`
}

Search refinements.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL