Models

Models re-exported from the Creators API SDK.

This module provides convenient access to all model classes from the creatorsapi_python_sdk package, so users can import them directly from amazon_creatorsapi.models instead of navigating the SDK structure.

Example

>>> from amazon_creatorsapi.models import Item, Condition, SortBy
>>> from amazon_creatorsapi.models import GetItemsResource, SearchItemsResource

class amazon_creatorsapi.models.Availability(*values)

Bases: str, Enum

The availability parameter filters available items on Amazon.

AVAILABLE = 'Available'

INCLUDEOUTOFSTOCK = 'IncludeOutOfStock'

classmethod from_json(json_str)

Create an instance of Availability from a JSON string

class amazon_creatorsapi.models.BrowseNode(*, ancestor=None, children=None, contextFreeName=None, displayName=None, id=None, isRoot=None, salesRank=None)

Bases: BaseModel

Container for BrowseNode information which includes BrowseNodeId, DisplayName, ContextFreeName, IsRoot, Ancestor, Children, SalesRank associated, etc.

ancestor

children

context_free_name

display_name

classmethod from_dict(obj)

Create an instance of BrowseNode from a dict

classmethod from_json(json_str)

Create an instance of BrowseNode from a JSON string

id

is_root

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

sales_rank

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.BrowseNodeAncestor(*, ancestor=None, contextFreeName=None, displayName=None, id=None)

Bases: BaseModel

Container for BrowseNode Ancestor information which includes BrowseNodeId, DisplayName, ContextFreeName and Ancestor information if one exists. The container is a ladder containing ancestor information up-to root browse node. That is, the last node in the ladder will be Root Node. Note that a root BrowseNode will not have any ancestor.

ancestor

context_free_name

display_name

classmethod from_dict(obj)

Create an instance of BrowseNodeAncestor from a dict

classmethod from_json(json_str)

Create an instance of BrowseNodeAncestor from a JSON string

id

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.BrowseNodeChild(*, contextFreeName=None, displayName=None, id=None)

Bases: BaseModel

Container for BrowseNode Child information which contains BrowseNodeId, DisplayName and ContextFreeName information associated with the BrowseNode Child.

context_free_name

display_name

classmethod from_dict(obj)

Create an instance of BrowseNodeChild from a dict

classmethod from_json(json_str)

Create an instance of BrowseNodeChild from a JSON string

id

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.BrowseNodeInfo(*, browseNodes=None, websiteSalesRank=None)

Bases: BaseModel

Container for BrowseNode information associated with a product. Includes WebsiteSalesRank and list of BrowseNodes associated with the product.

browse_nodes

classmethod from_dict(obj)

Create an instance of BrowseNodeInfo from a dict

classmethod from_json(json_str)

Create an instance of BrowseNodeInfo from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

website_sales_rank

class amazon_creatorsapi.models.ByLineInfo(*, brand=None, contributors=None, manufacturer=None)

Bases: BaseModel

Container for set of attributes that specifies basic information of the product like Brand, Manufacturer, etc.

brand

contributors

classmethod from_dict(obj)

Create an instance of ByLineInfo from a dict

classmethod from_json(json_str)

Create an instance of ByLineInfo from a JSON string

manufacturer

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.Classifications(*, binding=None, productGroup=None)

Bases: BaseModel

Container for set of attributes that are used to classify an item into a particular category.

binding

classmethod from_dict(obj)

Create an instance of Classifications from a dict

classmethod from_json(json_str)

Create an instance of Classifications from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

product_group

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.Condition(*values)

Bases: str, Enum

The condition parameter filters offers by condition type.

ANY = 'Any'

NEW = 'New'

classmethod from_json(json_str)

Create an instance of Condition from a JSON string

class amazon_creatorsapi.models.ContentInfo(*, edition=None, languages=None, pagesCount=None, publicationDate=None)

Bases: BaseModel

Container for set of attributes that are specific to the content like books, movies.

edition

classmethod from_dict(obj)

Create an instance of ContentInfo from a dict

classmethod from_json(json_str)

Create an instance of ContentInfo from a JSON string

languages

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pages_count

publication_date

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.ContentRating(*, audienceRating=None)

Bases: BaseModel

Container for set of attributes that tell what age group is suitable to view said media.

audience_rating

classmethod from_dict(obj)

Create an instance of ContentRating from a dict

classmethod from_json(json_str)

Create an instance of ContentRating from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.Contributor(*, locale=None, name=None, role=None, roleType=None)

Bases: BaseModel

Container for contributor associated with the product.

classmethod from_dict(obj)

Create an instance of Contributor from a dict

classmethod from_json(json_str)

Create an instance of Contributor from a JSON string

locale

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name

role

role_type

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.CustomerReviews(*, count=None, starRating=None)

Bases: BaseModel

Container for customer reviews information associated with a product. Includes weighted star rating and total reviews count.

count

classmethod from_dict(obj)

Create an instance of CustomerReviews from a dict

classmethod from_json(json_str)

Create an instance of CustomerReviews from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

star_rating

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.DealDetails(*, accessType=None, badge=None, earlyAccessDurationInMilliseconds=None, endTime=None, percentClaimed=None, startTime=None)

Bases: BaseModel

Specifies deal information about an offer.

access_type

badge

early_access_duration_in_milliseconds

end_time

classmethod from_dict(obj)

Create an instance of DealDetails from a dict

classmethod from_json(json_str)

Create an instance of DealDetails from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

percent_claimed

start_time

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.DeliveryFlag

Bases: str, Enum

AMAZONGLOBAL = 'AmazonGlobal'

FREESHIPPING = 'FreeShipping'

FULFILLEDBYAMAZON = 'FulfilledByAmazon'

PRIME = 'Prime'

classmethod from_json(json_str)

Create an instance of DeliveryFlag from a JSON string

class amazon_creatorsapi.models.ExternalIds(*, eans=None, isbns=None, upcs=None)

Bases: BaseModel

Container for set of identifiers that is used globally to identify a particular product.

eans

classmethod from_dict(obj)

Create an instance of ExternalIds from a dict

classmethod from_json(json_str)

Create an instance of ExternalIds from a JSON string

isbns

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

upcs

class amazon_creatorsapi.models.GetBrowseNodesResource(*values)

Bases: str, Enum

Resources for GetBrowseNodes operation which specify the values to return in the API response.

BROWSE_NODES_DOT_ANCESTOR = 'browseNodes.ancestor'

BROWSE_NODES_DOT_CHILDREN = 'browseNodes.children'

classmethod from_json(json_str)

Create an instance of GetBrowseNodesResource from a JSON string

class amazon_creatorsapi.models.GetItemsResource

Bases: str, Enum

BROWSE_NODE_INFO_DOT_BROWSE_NODES = 'browseNodeInfo.browseNodes'

BROWSE_NODE_INFO_DOT_BROWSE_NODES_DOT_ANCESTOR = 'browseNodeInfo.browseNodes.ancestor'

BROWSE_NODE_INFO_DOT_BROWSE_NODES_DOT_SALES_RANK = 'browseNodeInfo.browseNodes.salesRank'

BROWSE_NODE_INFO_DOT_WEBSITE_SALES_RANK = 'browseNodeInfo.websiteSalesRank'

CUSTOMER_REVIEWS_DOT_COUNT = 'customerReviews.count'

CUSTOMER_REVIEWS_DOT_STAR_RATING = 'customerReviews.starRating'

IMAGES_DOT_PRIMARY_DOT_HIGH_RES = 'images.primary.highRes'

IMAGES_DOT_PRIMARY_DOT_LARGE = 'images.primary.large'

IMAGES_DOT_PRIMARY_DOT_MEDIUM = 'images.primary.medium'

IMAGES_DOT_PRIMARY_DOT_SMALL = 'images.primary.small'

IMAGES_DOT_VARIANTS_DOT_HIGH_RES = 'images.variants.highRes'

IMAGES_DOT_VARIANTS_DOT_LARGE = 'images.variants.large'

IMAGES_DOT_VARIANTS_DOT_MEDIUM = 'images.variants.medium'

IMAGES_DOT_VARIANTS_DOT_SMALL = 'images.variants.small'

ITEM_INFO_DOT_BY_LINE_INFO = 'itemInfo.byLineInfo'

ITEM_INFO_DOT_CLASSIFICATIONS = 'itemInfo.classifications'

ITEM_INFO_DOT_CONTENT_INFO = 'itemInfo.contentInfo'

ITEM_INFO_DOT_CONTENT_RATING = 'itemInfo.contentRating'

ITEM_INFO_DOT_EXTERNAL_IDS = 'itemInfo.externalIds'

ITEM_INFO_DOT_FEATURES = 'itemInfo.features'

ITEM_INFO_DOT_MANUFACTURE_INFO = 'itemInfo.manufactureInfo'

ITEM_INFO_DOT_PRODUCT_INFO = 'itemInfo.productInfo'

ITEM_INFO_DOT_TECHNICAL_INFO = 'itemInfo.technicalInfo'

ITEM_INFO_DOT_TITLE = 'itemInfo.title'

ITEM_INFO_DOT_TRADE_IN_INFO = 'itemInfo.tradeInInfo'

OFFERS_V2_DOT_LISTINGS_DOT_AVAILABILITY = 'offersV2.listings.availability'

OFFERS_V2_DOT_LISTINGS_DOT_CONDITION = 'offersV2.listings.condition'

OFFERS_V2_DOT_LISTINGS_DOT_DEAL_DETAILS = 'offersV2.listings.dealDetails'

OFFERS_V2_DOT_LISTINGS_DOT_IS_BUY_BOX_WINNER = 'offersV2.listings.isBuyBoxWinner'

OFFERS_V2_DOT_LISTINGS_DOT_LOYALTY_POINTS = 'offersV2.listings.loyaltyPoints'

OFFERS_V2_DOT_LISTINGS_DOT_MERCHANT_INFO = 'offersV2.listings.merchantInfo'

OFFERS_V2_DOT_LISTINGS_DOT_PRICE = 'offersV2.listings.price'

OFFERS_V2_DOT_LISTINGS_DOT_TYPE = 'offersV2.listings.type'

PARENTASIN = 'parentASIN'

classmethod from_json(json_str)

Create an instance of GetItemsResource from a JSON string

class amazon_creatorsapi.models.GetVariationsResource

Bases: str, Enum

BROWSE_NODE_INFO_DOT_BROWSE_NODES = 'browseNodeInfo.browseNodes'

BROWSE_NODE_INFO_DOT_BROWSE_NODES_DOT_ANCESTOR = 'browseNodeInfo.browseNodes.ancestor'

BROWSE_NODE_INFO_DOT_BROWSE_NODES_DOT_SALES_RANK = 'browseNodeInfo.browseNodes.salesRank'

BROWSE_NODE_INFO_DOT_WEBSITE_SALES_RANK = 'browseNodeInfo.websiteSalesRank'

CUSTOMER_REVIEWS_DOT_COUNT = 'customerReviews.count'

CUSTOMER_REVIEWS_DOT_STAR_RATING = 'customerReviews.starRating'

IMAGES_DOT_PRIMARY_DOT_HIGH_RES = 'images.primary.highRes'

IMAGES_DOT_PRIMARY_DOT_LARGE = 'images.primary.large'

IMAGES_DOT_PRIMARY_DOT_MEDIUM = 'images.primary.medium'

IMAGES_DOT_PRIMARY_DOT_SMALL = 'images.primary.small'

IMAGES_DOT_VARIANTS_DOT_HIGH_RES = 'images.variants.highRes'

IMAGES_DOT_VARIANTS_DOT_LARGE = 'images.variants.large'

IMAGES_DOT_VARIANTS_DOT_MEDIUM = 'images.variants.medium'

IMAGES_DOT_VARIANTS_DOT_SMALL = 'images.variants.small'

ITEM_INFO_DOT_BY_LINE_INFO = 'itemInfo.byLineInfo'

ITEM_INFO_DOT_CLASSIFICATIONS = 'itemInfo.classifications'

ITEM_INFO_DOT_CONTENT_INFO = 'itemInfo.contentInfo'

ITEM_INFO_DOT_CONTENT_RATING = 'itemInfo.contentRating'

ITEM_INFO_DOT_EXTERNAL_IDS = 'itemInfo.externalIds'

ITEM_INFO_DOT_FEATURES = 'itemInfo.features'

ITEM_INFO_DOT_MANUFACTURE_INFO = 'itemInfo.manufactureInfo'

ITEM_INFO_DOT_PRODUCT_INFO = 'itemInfo.productInfo'

ITEM_INFO_DOT_TECHNICAL_INFO = 'itemInfo.technicalInfo'

ITEM_INFO_DOT_TITLE = 'itemInfo.title'

ITEM_INFO_DOT_TRADE_IN_INFO = 'itemInfo.tradeInInfo'

OFFERS_V2_DOT_LISTINGS_DOT_AVAILABILITY = 'offersV2.listings.availability'

OFFERS_V2_DOT_LISTINGS_DOT_CONDITION = 'offersV2.listings.condition'

OFFERS_V2_DOT_LISTINGS_DOT_DEAL_DETAILS = 'offersV2.listings.dealDetails'

OFFERS_V2_DOT_LISTINGS_DOT_IS_BUY_BOX_WINNER = 'offersV2.listings.isBuyBoxWinner'

OFFERS_V2_DOT_LISTINGS_DOT_LOYALTY_POINTS = 'offersV2.listings.loyaltyPoints'

OFFERS_V2_DOT_LISTINGS_DOT_MERCHANT_INFO = 'offersV2.listings.merchantInfo'

OFFERS_V2_DOT_LISTINGS_DOT_PRICE = 'offersV2.listings.price'

OFFERS_V2_DOT_LISTINGS_DOT_TYPE = 'offersV2.listings.type'

PARENTASIN = 'parentASIN'

VARIATION_SUMMARY_DOT_PRICE_DOT_HIGHEST_PRICE = 'variationSummary.price.highestPrice'

VARIATION_SUMMARY_DOT_PRICE_DOT_LOWEST_PRICE = 'variationSummary.price.lowestPrice'

VARIATION_SUMMARY_DOT_VARIATION_DIMENSION = 'variationSummary.variationDimension'

classmethod from_json(json_str)

Create an instance of GetVariationsResource from a JSON string

class amazon_creatorsapi.models.ImageSize(*, url=None, height=None, width=None)

Bases: BaseModel

Container for image attributes like URL, height and width for a particular image size of a particular image type.

classmethod from_dict(obj)

Create an instance of ImageSize from a dict

classmethod from_json(json_str)

Create an instance of ImageSize from a JSON string

height

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

url

width

class amazon_creatorsapi.models.ImageType(*, small=None, medium=None, large=None, hiRes=None)

Bases: BaseModel

Container for image sizes associated with an image type. Images are returned in various sizes like small, medium and large.

classmethod from_dict(obj)

Create an instance of ImageType from a dict

classmethod from_json(json_str)

Create an instance of ImageType from a JSON string

hi_res

large

medium

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

small

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.Images(*, primary=None, variants=None)

Bases: BaseModel

Container for image information associated with a product. Includes url, size, and other image attributes.

classmethod from_dict(obj)

Create an instance of Images from a dict

classmethod from_json(json_str)

Create an instance of Images from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

primary

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

variants

class amazon_creatorsapi.models.Item(*, asin=None, browseNodeInfo=None, customerReviews=None, detailPageURL=None, images=None, itemInfo=None, offersV2=None, parentASIN=None, score=None, variationAttributes=None)

Bases: BaseModel

Container for item information such as ASIN, Detail Page URL and other attributes. It also includes containers for various item related resources like Images, ItemInfo, etc.

asin

browse_node_info

customer_reviews

detail_page_url

classmethod from_dict(obj)

Create an instance of Item from a dict

classmethod from_json(json_str)

Create an instance of Item from a JSON string

images

item_info

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

offers_v2

parent_asin

score

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

variation_attributes

class amazon_creatorsapi.models.ItemInfo(*, byLineInfo=None, classifications=None, contentInfo=None, contentRating=None, externalIds=None, features=None, manufactureInfo=None, productInfo=None, technicalInfo=None, title=None, tradeInInfo=None)

Bases: BaseModel

Container for ItemInfo high level resource which is a collection of large number of attributes describing a product.

by_line_info

classifications

content_info

content_rating

external_ids

features

classmethod from_dict(obj)

Create an instance of ItemInfo from a dict

classmethod from_json(json_str)

Create an instance of ItemInfo from a JSON string

manufacture_info

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

product_info

technical_info

title

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

trade_in_info

class amazon_creatorsapi.models.LanguageType(*, displayValue=None, type=None)

Bases: BaseModel

Container for language type used to describe the language value associated with the item.

display_value

classmethod from_dict(obj)

Create an instance of LanguageType from a dict

classmethod from_json(json_str)

Create an instance of LanguageType from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

type

class amazon_creatorsapi.models.Languages(*, displayValues=None, label=None, locale=None)

Bases: BaseModel

Container for languages associated with the product.

display_values

classmethod from_dict(obj)

Create an instance of Languages from a dict

classmethod from_json(json_str)

Create an instance of Languages from a JSON string

label

locale

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.ManufactureInfo(*, itemPartNumber=None, model=None, warranty=None)

Bases: BaseModel

Container for set of attributes that specifies manufacturing related information of a product.

classmethod from_dict(obj)

Create an instance of ManufactureInfo from a dict

classmethod from_json(json_str)

Create an instance of ManufactureInfo from a JSON string

item_part_number

model

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

warranty

class amazon_creatorsapi.models.Money(*, amount=None, currency=None, displayAmount=None)

Bases: BaseModel

Used to return the information about the Money value or amount. Consists of the integral value, the currency codes and the formatted price which can be used for display purposes.

amount

currency

display_amount

classmethod from_dict(obj)

Create an instance of Money from a dict

classmethod from_json(json_str)

Create an instance of Money from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.OfferAvailabilityV2(*, message=None, maxOrderQuantity=None, minOrderQuantity=None, type=None)

Bases: BaseModel

Specifies availability information about an offer.

classmethod from_dict(obj)

Create an instance of OfferAvailabilityV2 from a dict

classmethod from_json(json_str)

Create an instance of OfferAvailabilityV2 from a JSON string

max_order_quantity

message

min_order_quantity

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

type

class amazon_creatorsapi.models.OfferConditionV2(*, value=None, subCondition=None, conditionNote=None)

Bases: BaseModel

Specifies the condition of the offer.

condition_note

classmethod from_dict(obj)

Create an instance of OfferConditionV2 from a dict

classmethod from_json(json_str)

Create an instance of OfferConditionV2 from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

sub_condition

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

value

class amazon_creatorsapi.models.OfferListingV2(*, availability=None, condition=None, dealDetails=None, isBuyBoxWinner=None, loyaltyPoints=None, merchantInfo=None, price=None, type=None, violatesMAP=None)

Bases: BaseModel

Specifies about various offer listings associated with the product.

availability

condition

deal_details

classmethod from_dict(obj)

Create an instance of OfferListingV2 from a dict

classmethod from_json(json_str)

Create an instance of OfferListingV2 from a JSON string

is_buy_box_winner

loyalty_points

merchant_info

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

price

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

type

violates_map

class amazon_creatorsapi.models.OfferLoyaltyPointsV2(*, points=None)

Bases: BaseModel

Specifies loyalty points in any region against an offer. Right now, only supporting JP marketplace.

classmethod from_dict(obj)

Create an instance of OfferLoyaltyPointsV2 from a dict

classmethod from_json(json_str)

Create an instance of OfferLoyaltyPointsV2 from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

points

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.OfferMerchantInfoV2(*, name=None, id=None)

Bases: BaseModel

Specifies seller information of an offer.

classmethod from_dict(obj)

Create an instance of OfferMerchantInfoV2 from a dict

classmethod from_json(json_str)

Create an instance of OfferMerchantInfoV2 from a JSON string

id

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.OfferPriceV2(*, money=None, pricePerUnit=None, savings=None, savingBasis=None)

Bases: BaseModel

Specifies buying price of an offer.

classmethod from_dict(obj)

Create an instance of OfferPriceV2 from a dict

classmethod from_json(json_str)

Create an instance of OfferPriceV2 from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

money

price_per_unit

saving_basis

savings

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.OfferSavingBasis(*, money=None, savingBasisType=None, savingBasisTypeLabel=None)

Bases: BaseModel

Specifies Saving Basis of an offer

classmethod from_dict(obj)

Create an instance of OfferSavingBasis from a dict

classmethod from_json(json_str)

Create an instance of OfferSavingBasis from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

money

saving_basis_type

saving_basis_type_label

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.OfferSavings(*, money=None, percentage=None)

Bases: BaseModel

Specifies savings on an offer. This is calculated by taking reference as saving basis price.

classmethod from_dict(obj)

Create an instance of OfferSavings from a dict

classmethod from_json(json_str)

Create an instance of OfferSavings from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

money

percentage

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.OfferType(*values)

Bases: str, Enum

The OfferType is an optional parameter that indicates the type of offer. We only use this for special callouts. Standard Offers will not have a particular type.

HAUL = 'HAUL'

LIGHTNING_DEAL = 'LIGHTNING_DEAL'

SUBSCRIBE_AND_SAVE = 'SUBSCRIBE_AND_SAVE'

classmethod from_json(json_str)

Create an instance of OfferType from a JSON string

class amazon_creatorsapi.models.OffersV2(*, listings=None)

Bases: BaseModel

The Offers resource contains various resources related to offer listings and summaries for an item.

classmethod from_dict(obj)

Create an instance of OffersV2 from a dict

classmethod from_json(json_str)

Create an instance of OffersV2 from a JSON string

listings

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.ProductInfo(*, color=None, isAdultProduct=None, itemDimensions=None, releaseDate=None, size=None, unitCount=None)

Bases: BaseModel

Container for set of attributes that describes non-technical aspects of the product.

color

classmethod from_dict(obj)

Create an instance of ProductInfo from a dict

classmethod from_json(json_str)

Create an instance of ProductInfo from a JSON string

is_adult_product

item_dimensions

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

release_date

size

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

unit_count

class amazon_creatorsapi.models.Refinement(*, bins=None, displayName=None, id=None)

Bases: BaseModel

Container for a search refinement which includes refinement attributes like Id, Display Name and refinement values.

bins

display_name

classmethod from_dict(obj)

Create an instance of Refinement from a dict

classmethod from_json(json_str)

Create an instance of Refinement from a JSON string

id

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.RefinementBin(*, displayName=None, id=None)

Bases: BaseModel

Container for a refinement bin which contains values for a particular refinement.

display_name

classmethod from_dict(obj)

Create an instance of RefinementBin from a dict

classmethod from_json(json_str)

Create an instance of RefinementBin from a JSON string

id

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.SavingBasisType(*values)

Bases: str, Enum

The SavingBasisType parameter is used for EU omnibus compliance.

LIST_PRICE = 'LIST_PRICE'

LOWEST_PRICE = 'LOWEST_PRICE'

LOWEST_PRICE_STRIKETHROUGH = 'LOWEST_PRICE_STRIKETHROUGH'

WAS_PRICE = 'WAS_PRICE'

classmethod from_json(json_str)

Create an instance of SavingBasisType from a JSON string

class amazon_creatorsapi.models.SearchItemsResource

Bases: str, Enum

BROWSE_NODE_INFO_DOT_BROWSE_NODES = 'browseNodeInfo.browseNodes'

BROWSE_NODE_INFO_DOT_BROWSE_NODES_DOT_ANCESTOR = 'browseNodeInfo.browseNodes.ancestor'

BROWSE_NODE_INFO_DOT_BROWSE_NODES_DOT_SALES_RANK = 'browseNodeInfo.browseNodes.salesRank'

BROWSE_NODE_INFO_DOT_WEBSITE_SALES_RANK = 'browseNodeInfo.websiteSalesRank'

CUSTOMER_REVIEWS_DOT_COUNT = 'customerReviews.count'

CUSTOMER_REVIEWS_DOT_STAR_RATING = 'customerReviews.starRating'

IMAGES_DOT_PRIMARY_DOT_HIGH_RES = 'images.primary.highRes'

IMAGES_DOT_PRIMARY_DOT_LARGE = 'images.primary.large'

IMAGES_DOT_PRIMARY_DOT_MEDIUM = 'images.primary.medium'

IMAGES_DOT_PRIMARY_DOT_SMALL = 'images.primary.small'

IMAGES_DOT_VARIANTS_DOT_HIGH_RES = 'images.variants.highRes'

IMAGES_DOT_VARIANTS_DOT_LARGE = 'images.variants.large'

IMAGES_DOT_VARIANTS_DOT_MEDIUM = 'images.variants.medium'

IMAGES_DOT_VARIANTS_DOT_SMALL = 'images.variants.small'

ITEM_INFO_DOT_BY_LINE_INFO = 'itemInfo.byLineInfo'

ITEM_INFO_DOT_CLASSIFICATIONS = 'itemInfo.classifications'

ITEM_INFO_DOT_CONTENT_INFO = 'itemInfo.contentInfo'

ITEM_INFO_DOT_CONTENT_RATING = 'itemInfo.contentRating'

ITEM_INFO_DOT_EXTERNAL_IDS = 'itemInfo.externalIds'

ITEM_INFO_DOT_FEATURES = 'itemInfo.features'

ITEM_INFO_DOT_MANUFACTURE_INFO = 'itemInfo.manufactureInfo'

ITEM_INFO_DOT_PRODUCT_INFO = 'itemInfo.productInfo'

ITEM_INFO_DOT_TECHNICAL_INFO = 'itemInfo.technicalInfo'

ITEM_INFO_DOT_TITLE = 'itemInfo.title'

ITEM_INFO_DOT_TRADE_IN_INFO = 'itemInfo.tradeInInfo'

OFFERS_V2_DOT_LISTINGS_DOT_AVAILABILITY = 'offersV2.listings.availability'

OFFERS_V2_DOT_LISTINGS_DOT_CONDITION = 'offersV2.listings.condition'

OFFERS_V2_DOT_LISTINGS_DOT_DEAL_DETAILS = 'offersV2.listings.dealDetails'

OFFERS_V2_DOT_LISTINGS_DOT_IS_BUY_BOX_WINNER = 'offersV2.listings.isBuyBoxWinner'

OFFERS_V2_DOT_LISTINGS_DOT_LOYALTY_POINTS = 'offersV2.listings.loyaltyPoints'

OFFERS_V2_DOT_LISTINGS_DOT_MERCHANT_INFO = 'offersV2.listings.merchantInfo'

OFFERS_V2_DOT_LISTINGS_DOT_PRICE = 'offersV2.listings.price'

OFFERS_V2_DOT_LISTINGS_DOT_TYPE = 'offersV2.listings.type'

PARENTASIN = 'parentASIN'

SEARCHREFINEMENTS = 'searchRefinements'

classmethod from_json(json_str)

Create an instance of SearchItemsResource from a JSON string

class amazon_creatorsapi.models.SearchRefinements(*, browseNode=None, otherRefinements=None, searchIndex=None)

Bases: BaseModel

Container for SearchRefinements resource which helps in filtering search results obtained from SearchItems operation. It contains relevant SearchIndexes, BrowseNodes and other dynamic refinements for a search request.

browse_node

classmethod from_dict(obj)

Create an instance of SearchRefinements from a dict

classmethod from_json(json_str)

Create an instance of SearchRefinements from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

other_refinements

search_index

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.SearchResult(*, totalResultCount=None, searchURL=None, items=None, searchRefinements=None)

Bases: BaseModel

The container for SearchItems response. It consists of search results items and some meta-data about the search result like TotalResultCount, SearchURL and SearchRefinements.

classmethod from_dict(obj)

Create an instance of SearchResult from a dict

classmethod from_json(json_str)

Create an instance of SearchResult from a JSON string

items

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

search_refinements

search_url

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

total_result_count

class amazon_creatorsapi.models.SortBy(*values)

Bases: str, Enum

Specifies the way in which items in the response are sorted.

AVGCUSTOMERREVIEWS = 'AvgCustomerReviews'

FEATURED = 'Featured'

NEWESTARRIVALS = 'NewestArrivals'

PRICE_COLON_HIGH_TO_LOW = 'Price:HighToLow'

PRICE_COLON_LOW_TO_HIGH = 'Price:LowToHigh'

RELEVANCE = 'Relevance'

classmethod from_json(json_str)

Create an instance of SortBy from a JSON string

class amazon_creatorsapi.models.TechnicalInfo(*, energyEfficiencyClass=None, formats=None)

Bases: BaseModel

Container for set of attributes that describes the technical aspects of the product.

energy_efficiency_class

formats

classmethod from_dict(obj)

Create an instance of TechnicalInfo from a dict

classmethod from_json(json_str)

Create an instance of TechnicalInfo from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.TradeInInfo(*, isEligibleForTradeIn=None, price=None)

Bases: BaseModel

Container for set of attributes that specifies trade-in information of the product.

classmethod from_dict(obj)

Create an instance of TradeInInfo from a dict

classmethod from_json(json_str)

Create an instance of TradeInInfo from a JSON string

is_eligible_for_trade_in

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

price

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.TradeInPrice(*, amount=None, currency=None, displayAmount=None)

Bases: BaseModel

Specifies trade-in price of the product.

amount

currency

display_amount

classmethod from_dict(obj)

Create an instance of TradeInPrice from a dict

classmethod from_json(json_str)

Create an instance of TradeInPrice from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

class amazon_creatorsapi.models.VariationAttribute(*, name=None, value=None)

Bases: BaseModel

Container for Variation information on which the item is variating.

classmethod from_dict(obj)

Create an instance of VariationAttribute from a dict

classmethod from_json(json_str)

Create an instance of VariationAttribute from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

value

class amazon_creatorsapi.models.VariationDimension(*, displayName=None, locale=None, name=None, values=None)

Bases: BaseModel

The container for variation dimension which represent a dimension and all its possible values.

display_name

classmethod from_dict(obj)

Create an instance of VariationDimension from a dict

classmethod from_json(json_str)

Create an instance of VariationDimension from a JSON string

locale

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

values

class amazon_creatorsapi.models.VariationSummary(*, pageCount=None, price=None, variationCount=None, variationDimensions=None)

Bases: BaseModel

The container for Variations Summary response. It consists of metadata of variations response like page numbers, number of variations, Price range and Variation Dimensions.

classmethod from_dict(obj)

Create an instance of VariationSummary from a dict

classmethod from_json(json_str)

Create an instance of VariationSummary from a JSON string

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

page_count

price

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

variation_count

variation_dimensions

class amazon_creatorsapi.models.VariationsResult(*, items=None, variationSummary=None)

Bases: BaseModel

The container for Variations response. It consists of items and variation summary. Items contains the list of product variations with their attributes (e.g., different colors, sizes). VariationSummary provides metadata about the complete set of variations including pagination info, price range, and the dimensions along which products vary.

classmethod from_dict(obj)

Create an instance of VariationsResult from a dict

classmethod from_json(json_str)

Create an instance of VariationsResult from a JSON string

items

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias

variation_summary

class amazon_creatorsapi.models.WebsiteSalesRank(*, contextFreeName=None, displayName=None, id=None, salesRank=None)

Bases: BaseModel

Container for Website Sales Rank associated with a product. Includes BrowseNodeId, DisplayName, ContextFreeName and SalesRank information.

context_free_name

display_name

classmethod from_dict(obj)

Create an instance of WebsiteSalesRank from a dict

classmethod from_json(json_str)

Create an instance of WebsiteSalesRank from a JSON string

id

model_config = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

sales_rank

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

to_str()

Returns the string representation of the model using alias