catalogItems20220401

type BrandRefinement struct {
	// BrandName The brand name that you can use to refine your search.
	BrandName string `json:"brandName"`

	// NumberOfResults The estimated number of results that would be returned if you refine your search by the specified `brandName`.
	NumberOfResults int `json:"numberOfResults"`
}

type ClassificationRefinement struct {
	// ClassificationId The identifier of the classification that you can use to refine your search.
	ClassificationId string `json:"classificationId"`

	// DisplayName Display name for the classification.
	DisplayName string `json:"displayName"`

	// NumberOfResults The estimated number of results that would be returned if you refine your search by the specified `classificationId`.
	NumberOfResults int `json:"numberOfResults"`
}

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn

	// A callback for modifying response which are generated after receive from the network.
	ResponseEditors []ResponseEditorFn

	// The user agent header identifies your application, its version number, and the platform and programming language you are using.
	// You must include a user agent header in each request submitted to the sales partner API.
	UserAgent string
}

type ClientInterface interface {
	// SearchCatalogItems request
	SearchCatalogItems(ctx context.Context, params *SearchCatalogItemsParams) (*http.Response, error)

	// GetCatalogItem request
	GetCatalogItem(ctx context.Context, asin string, params *GetCatalogItemParams) (*http.Response, error)
}

type ClientOption func(*Client) error

type ClientWithResponses struct {
	ClientInterface
}

type ClientWithResponsesInterface interface {
	// SearchCatalogItemsWithResponse request
	SearchCatalogItemsWithResponse(ctx context.Context, params *SearchCatalogItemsParams) (*SearchCatalogItemsResp, error)

	// GetCatalogItemWithResponse request
	GetCatalogItemWithResponse(ctx context.Context, asin string, params *GetCatalogItemParams) (*GetCatalogItemResp, error)
}

type Dimension struct {
	// Unit Unit of measurement for the dimension value.
	Unit *string `json:"unit,omitempty"`

	// Value Numeric value of the dimension.
	Value *float32 `json:"value,omitempty"`
}

type Dimensions struct {
	// Height The value of an individual dimension for an Amazon catalog item or item package.
	Height *Dimension `json:"height,omitempty"`

	// Length The value of an individual dimension for an Amazon catalog item or item package.
	Length *Dimension `json:"length,omitempty"`

	// Weight The value of an individual dimension for an Amazon catalog item or item package.
	Weight *Dimension `json:"weight,omitempty"`

	// Width The value of an individual dimension for an Amazon catalog item or item package.
	Width *Dimension `json:"width,omitempty"`
}

type Error struct {
	// Code An error code that identifies the type of error that occurred.
	Code string `json:"code"`

	// Details Additional details that can help the caller understand or fix the issue.
	Details *string `json:"details,omitempty"`

	// Message A message that describes the error condition.
	Message string `json:"message"`
}

type ErrorList struct {
	// Errors A list of error responses returned when a request is unsuccessful.
	Errors []Error `json:"errors"`
}

type GetCatalogItemParams struct {
	// MarketplaceIds A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
	MarketplaceIds []string `form:"marketplaceIds" json:"marketplaceIds"`

	// IncludedData A comma-delimited list of datasets to include in the response.
	IncludedData *[]GetCatalogItemParamsIncludedData `form:"includedData,omitempty" json:"includedData,omitempty"`

	// Locale The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
	Locale *string `form:"locale,omitempty" json:"locale,omitempty"`
}

type GetCatalogItemParamsIncludedData string

type GetCatalogItemResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Item
	JSON400      *ErrorList
	JSON403      *ErrorList
	JSON404      *ErrorList
	JSON413      *ErrorList
	JSON415      *ErrorList
	JSON429      *ErrorList
	JSON500      *ErrorList
	JSON503      *ErrorList
}

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

type Item struct {
	// Asin The unique identifier of an item in the Amazon catalog.
	Asin ItemAsin `json:"asin"`

	// Attributes A JSON object containing structured item attribute data that is keyed by attribute name. Catalog item attributes conform to the related Amazon product type definitions that you can get from the [Product Type Definitions API](https://developer-docs.amazon.com/sp-api/reference/product-type-definitions-v2020-09-01).
	Attributes *ItemAttributes `json:"attributes,omitempty"`

	// Classifications An array of classifications (browse nodes) that is associated with the item in the Amazon catalog, grouped by `marketplaceId`.
	Classifications *ItemBrowseClassifications `json:"classifications,omitempty"`

	// Dimensions An array of dimensions that are associated with the item in the Amazon catalog, grouped by `marketplaceId`.
	Dimensions *ItemDimensions `json:"dimensions,omitempty"`

	// Identifiers Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers.
	Identifiers *ItemIdentifiers `json:"identifiers,omitempty"`

	// Images The images for an item in the Amazon catalog.
	Images *ItemImages `json:"images,omitempty"`

	// ProductTypes Product types that are associated with the Amazon catalog item.
	ProductTypes *ItemProductTypes `json:"productTypes,omitempty"`

	// Relationships Relationships grouped by `marketplaceId` for an Amazon catalog item (for example, variations).
	Relationships *ItemRelationships `json:"relationships,omitempty"`

	// SalesRanks Sales ranks of an Amazon catalog item.
	SalesRanks *ItemSalesRanks `json:"salesRanks,omitempty"`

	// Summaries Summaries of Amazon catalog items.
	Summaries *ItemSummaries `json:"summaries,omitempty"`

	// VendorDetails The vendor details that are associated with an Amazon catalog item. Vendor details are only available to vendors.
	VendorDetails *ItemVendorDetails `json:"vendorDetails,omitempty"`
}

type ItemAsin = string

type ItemAttributes map[string]interface{}

type ItemBrowseClassification struct {
	// ClassificationId Identifier of the classification.
	ClassificationId string `json:"classificationId"`

	// DisplayName Display name for the classification.
	DisplayName string `json:"displayName"`

	// Parent Classification (browse node) for an Amazon catalog item.
	Parent *ItemBrowseClassification `json:"parent,omitempty"`
}

type ItemBrowseClassifications = []ItemBrowseClassificationsByMarketplace

type ItemBrowseClassificationsByMarketplace struct {
	// Classifications Classifications (browse nodes) that are associated with the item in the Amazon catalog.
	Classifications *[]ItemBrowseClassification `json:"classifications,omitempty"`

	// MarketplaceId Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
	MarketplaceId string `json:"marketplaceId"`
}

type ItemClassificationSalesRank struct {
	// ClassificationId Identifier of the classification that is associated with the sales rank.
	ClassificationId string `json:"classificationId"`

	// Link Corresponding Amazon retail website URL for the sales category.
	Link *string `json:"link,omitempty"`

	// Rank Sales rank.
	Rank int `json:"rank"`

	// Title Name of the sales rank.
	Title string `json:"title"`
}

type ItemContributor struct {
	// Role Role of an individual contributor in the creation of an item, such as author or actor.
	Role ItemContributorRole `json:"role"`

	// Value Name of the contributor, such as `Jane Austen`.
	Value string `json:"value"`
}

type ItemContributorRole struct {
	// DisplayName Display name of the role in the requested locale, such as `Author` or `Actor`.
	DisplayName *string `json:"displayName,omitempty"`

	// Value Role value for the Amazon catalog item, such as `author` or `actor`.
	Value string `json:"value"`
}

type ItemDimensions = []ItemDimensionsByMarketplace

type ItemDimensionsByMarketplace struct {
	// Item Dimensions of an Amazon catalog item or item in its packaging.
	Item *Dimensions `json:"item,omitempty"`

	// MarketplaceId Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
	MarketplaceId string `json:"marketplaceId"`

	// Package Dimensions of an Amazon catalog item or item in its packaging.
	Package *Dimensions `json:"package,omitempty"`
}

type ItemDisplayGroupSalesRank struct {
	// Link Corresponding Amazon retail website URL for the sales rank.
	Link *string `json:"link,omitempty"`

	// Rank Sales rank.
	Rank int `json:"rank"`

	// Title Name of the sales rank.
	Title string `json:"title"`

	// WebsiteDisplayGroup Name of the website display group that is associated with the sales rank
	WebsiteDisplayGroup string `json:"websiteDisplayGroup"`
}

type ItemIdentifier struct {
	// Identifier Identifier of the item.
	Identifier string `json:"identifier"`

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

type ItemIdentifiers = []ItemIdentifiersByMarketplace

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

	// MarketplaceId Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).identifier.
	MarketplaceId string `json:"marketplaceId"`
}

type ItemImage struct {
	// Height Height of the image in pixels.
	Height int `json:"height"`

	// Link URL for the image.
	Link string `json:"link"`

	// Variant Variant of the image, such as `MAIN` or `PT01`.
	Variant ItemImageVariant `json:"variant"`

	// Width Width of the image in pixels.
	Width int `json:"width"`
}

type ItemImageVariant string

type ItemImages = []ItemImagesByMarketplace

type ItemImagesByMarketplace struct {
	// Images Images for an item in the Amazon catalog, grouped by `marketplaceId`.
	Images []ItemImage `json:"images"`

	// MarketplaceId Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
	MarketplaceId string `json:"marketplaceId"`
}

type ItemProductTypeByMarketplace struct {
	// MarketplaceId Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
	MarketplaceId *string `json:"marketplaceId,omitempty"`

	// ProductType Name of the product type that is associated with the Amazon catalog item.
	ProductType *string `json:"productType,omitempty"`
}

type ItemProductTypes = []ItemProductTypeByMarketplace

type ItemRelationship struct {
	// ChildAsins ASINs of the related items that are children of this item.
	ChildAsins *[]string `json:"childAsins,omitempty"`

	// ParentAsins ASINs of the related items that are parents of this item.
	ParentAsins *[]string `json:"parentAsins,omitempty"`

	// Type Type of relationship.
	Type ItemRelationshipType `json:"type"`

	// VariationTheme The variation theme is a list of Amazon catalog item attributes that define the variation family.
	VariationTheme *ItemVariationTheme `json:"variationTheme,omitempty"`
}

type ItemRelationshipType string

type ItemRelationships = []ItemRelationshipsByMarketplace

type ItemRelationshipsByMarketplace struct {
	// MarketplaceId Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
	MarketplaceId string `json:"marketplaceId"`

	// Relationships Relationships for the item.
	Relationships []ItemRelationship `json:"relationships"`
}

type ItemSalesRanks = []ItemSalesRanksByMarketplace

type ItemSalesRanksByMarketplace struct {
	// ClassificationRanks Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification.
	ClassificationRanks *[]ItemClassificationSalesRank `json:"classificationRanks,omitempty"`

	// DisplayGroupRanks Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group.
	DisplayGroupRanks *[]ItemDisplayGroupSalesRank `json:"displayGroupRanks,omitempty"`

	// MarketplaceId Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
	MarketplaceId string `json:"marketplaceId"`
}

type ItemSearchResults struct {
	// Items A list of items from the Amazon catalog.
	Items []Item `json:"items"`

	// NumberOfResults For searches that are based on `identifiers`, `numberOfResults` is the total number of Amazon catalog items found. For searches that are based on `keywords`, `numberOfResults` is the estimated total number of Amazon catalog items that are matched by the search query. Only results up to the page count limit are returned per request regardless of the number found.
	//
	// **Note:** The maximum number of items (ASINs) that can be returned and paged through is 1,000.
	NumberOfResults int `json:"numberOfResults"`

	// Pagination Pagination occurs when a request produces a response that exceeds the `pageSize`. This means that the response is divided into individual pages. To retrieve the next page or the previous page of results, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. There is no `nextToken` in the pagination object on the last page.
	Pagination *Pagination `json:"pagination,omitempty"`

	// Refinements Optional fields that you can use to refine your search results.
	Refinements *Refinements `json:"refinements,omitempty"`
}

type ItemSummaries = []ItemSummaryByMarketplace

type ItemSummaryByMarketplace struct {
	// AdultProduct When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature.
	AdultProduct *bool `json:"adultProduct,omitempty"`

	// Autographed When `true`, the Amazon catalog item is autographed.
	Autographed *bool `json:"autographed,omitempty"`

	// Brand Name of the brand that is associated with the Amazon catalog item.
	Brand *string `json:"brand,omitempty"`

	// BrowseClassification Classification (browse node) for an Amazon catalog item.
	BrowseClassification *ItemBrowseClassification `json:"browseClassification,omitempty"`

	// Color The color that is associated with the Amazon catalog item.
	Color *string `json:"color,omitempty"`

	// Contributors Individual contributors to the creation of the item, such as the authors or actors.
	Contributors *[]ItemContributor `json:"contributors,omitempty"`

	// ItemClassification Classification type that is associated with the Amazon catalog item.
	ItemClassification *ItemSummaryByMarketplaceItemClassification `json:"itemClassification,omitempty"`

	// ItemName The name that is associated with the Amazon catalog item.
	ItemName *string `json:"itemName,omitempty"`

	// Manufacturer The name of the manufacturer that is associated with the Amazon catalog item.
	Manufacturer *string `json:"manufacturer,omitempty"`

	// MarketplaceId Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
	MarketplaceId string `json:"marketplaceId"`

	// Memorabilia When true, the item is classified as memorabilia.
	Memorabilia *bool `json:"memorabilia,omitempty"`

	// ModelNumber The model number that is associated with the Amazon catalog item.
	ModelNumber *string `json:"modelNumber,omitempty"`

	// PackageQuantity The quantity of the Amazon catalog item within one package.
	PackageQuantity *int `json:"packageQuantity,omitempty"`

	// PartNumber The part number that is associated with the Amazon catalog item.
	PartNumber *string `json:"partNumber,omitempty"`

	// ReleaseDate The earliest date on which the Amazon catalog item can be shipped to customers.
	ReleaseDate *openapi_types.Date `json:"releaseDate,omitempty"`

	// Size The name of the size of the Amazon catalog item.
	Size *string `json:"size,omitempty"`

	// Style The name of the style that is associated with the Amazon catalog item.
	Style *string `json:"style,omitempty"`

	// TradeInEligible When true, the Amazon catalog item is eligible for trade-in.
	TradeInEligible *bool `json:"tradeInEligible,omitempty"`

	// WebsiteDisplayGroup The identifier of the website display group that is associated with the Amazon catalog item.
	WebsiteDisplayGroup *string `json:"websiteDisplayGroup,omitempty"`

	// WebsiteDisplayGroupName The display name of the website display group that is associated with the Amazon catalog item.
	WebsiteDisplayGroupName *string `json:"websiteDisplayGroupName,omitempty"`
}

type ItemSummaryByMarketplaceItemClassification string

type ItemVariationTheme struct {
	// Attributes Names of the Amazon catalog item attributes that are associated with the variation theme.
	Attributes *[]string `json:"attributes,omitempty"`

	// Theme Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family.
	Theme *string `json:"theme,omitempty"`
}

type ItemVendorDetails = []ItemVendorDetailsByMarketplace

type ItemVendorDetailsByMarketplace struct {
	// BrandCode The brand code that is associated with an Amazon catalog item.
	BrandCode *string `json:"brandCode,omitempty"`

	// ManufacturerCode The manufacturer code that is associated with an Amazon catalog item.
	ManufacturerCode *string `json:"manufacturerCode,omitempty"`

	// ManufacturerCodeParent The parent vendor code of the manufacturer code.
	ManufacturerCodeParent *string `json:"manufacturerCodeParent,omitempty"`

	// MarketplaceId Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
	MarketplaceId string `json:"marketplaceId"`

	// ProductCategory The product category or subcategory that is associated with an Amazon catalog item.
	ProductCategory *ItemVendorDetailsCategory `json:"productCategory,omitempty"`

	// ProductGroup The product group that is associated with an Amazon catalog item.
	ProductGroup *string `json:"productGroup,omitempty"`

	// ProductSubcategory The product category or subcategory that is associated with an Amazon catalog item.
	ProductSubcategory *ItemVendorDetailsCategory `json:"productSubcategory,omitempty"`

	// ReplenishmentCategory The replenishment category that is associated with an Amazon catalog item.
	ReplenishmentCategory *ItemVendorDetailsByMarketplaceReplenishmentCategory `json:"replenishmentCategory,omitempty"`
}

type ItemVendorDetailsByMarketplaceReplenishmentCategory string

type ItemVendorDetailsCategory struct {
	// DisplayName The display name of the product category or subcategory.
	DisplayName *string `json:"displayName,omitempty"`

	// Value The code that identifies the product category or subcategory.
	Value *string `json:"value,omitempty"`
}

type Pagination struct {
	// NextToken A token that you can use to retrieve the next page.
	NextToken *string `json:"nextToken,omitempty"`

	// PreviousToken A token that you can use to retrieve the previous page.
	PreviousToken *string `json:"previousToken,omitempty"`
}

type Refinements struct {
	// Brands A list of brands you can use to refine your search.
	Brands []BrandRefinement `json:"brands"`

	// Classifications A list of classifications you can use to refine your search.
	Classifications []ClassificationRefinement `json:"classifications"`
}

type RequestEditorFn func(ctx context.Context, req *http.Request) error

type ResponseEditorFn func(ctx context.Context, rsp *http.Response) error

type SearchCatalogItemsParams struct {
	// Identifiers A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include `identifiers` and `keywords` in the same request.
	Identifiers *[]string `form:"identifiers,omitempty" json:"identifiers,omitempty"`

	// IdentifiersType The type of product identifiers that you can use to search the Amazon catalog. **Note:** `identifiersType` is required when `identifiers` is in the request.
	IdentifiersType *SearchCatalogItemsParamsIdentifiersType `form:"identifiersType,omitempty" json:"identifiersType,omitempty"`

	// MarketplaceIds A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
	MarketplaceIds []string `form:"marketplaceIds" json:"marketplaceIds"`

	// IncludedData A comma-delimited list of datasets to include in the response.
	IncludedData *[]SearchCatalogItemsParamsIncludedData `form:"includedData,omitempty" json:"includedData,omitempty"`

	// Locale The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
	Locale *string `form:"locale,omitempty" json:"locale,omitempty"`

	// SellerId A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`.
	SellerId *string `form:"sellerId,omitempty" json:"sellerId,omitempty"`

	// Keywords A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include `keywords` and `identifiers` in the same request.
	Keywords *[]string `form:"keywords,omitempty" json:"keywords,omitempty"`

	// BrandNames A comma-delimited list of brand names that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
	BrandNames *[]string `form:"brandNames,omitempty" json:"brandNames,omitempty"`

	// ClassificationIds A comma-delimited list of classification identifiers that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
	ClassificationIds *[]string `form:"classificationIds,omitempty" json:"classificationIds,omitempty"`

	// PageSize The number of results to include on each page.
	PageSize *int `form:"pageSize,omitempty" json:"pageSize,omitempty"`

	// PageToken A token that you can use to fetch a specific page when there are multiple pages of results.
	PageToken *string `form:"pageToken,omitempty" json:"pageToken,omitempty"`

	// KeywordsLocale The language of the keywords that are included in queries based on `keywords`. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`.
	KeywordsLocale *string `form:"keywordsLocale,omitempty" json:"keywordsLocale,omitempty"`
}

type SearchCatalogItemsParamsIdentifiersType string

type SearchCatalogItemsParamsIncludedData string

type SearchCatalogItemsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ItemSearchResults
	JSON400      *ErrorList
	JSON403      *ErrorList
	JSON404      *ErrorList
	JSON413      *ErrorList
	JSON415      *ErrorList
	JSON429      *ErrorList
	JSON500      *ErrorList
	JSON503      *ErrorList
}