Schema

Suggest Edits

O schema geral da API é disponibilizado através do Playground. Nele é possível verificar os campos disponíveis, seus tipos e descrições.

Schema Types

Table of Contents

Query
Mutation
Objects
Inputs
Enums
Scalars
- Boolean
- CEP
- CountryCode
- DateTime
- Decimal
- EmailAddress
- Float
- ID
- Int
- Long
- String
- Uuid
Interfaces
- Node

Query (QueryRoot)

Field	Type	Description
autocomplete	Autocomplete	Get query completion suggestion.
limit	Int
partnerAccessToken	String	The partner access token.
query	String
banners	BannersConnection	List of banners.
after	String	Returns the elements in the list that come after the specified cursor.
bannerIds	[Long!]	Filter the list by specific banner ids.
before	String	Returns the elements in the list that come before the specified cursor.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
partnerAccessToken	String
sortDirection	SortDirection!
sortKey	BannerSortKeys!
brands	BrandsConnection	List of brands
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
brandInput	BrandFilterInput	Brand input
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
sortDirection	SortDirection!
sortKey	BrandSortKeys!
categories	CategoriesConnection	List of categories.
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
categoryIds	[Long!]	Filter the list by specific category ids.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
sortDirection	SortDirection!
sortKey	CategorySortKeys!
checkout	Checkout	Get info from the checkout cart corresponding to the given ID.
checkoutId	String!	The cart ID used for checkout operations.
contents	ContentsConnection	List of contents.
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
contentIds	[Long!]	Filter the list by specific content ids.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
sortDirection	SortDirection!
sortKey	ContentSortKeys!
customer	Customer	Get informations about a customer from the store.
customerAccessToken	String	The customer access token.
hotsite	SingleHotsite	Retrieve a single hotsite. A hotsite consists of products, banners and contents.
hotsiteId	Long
url	String
hotsites	HotsitesConnection	List of the shop's hotsites. A hotsite consists of products, banners and contents.
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
first	Int	Returns the first n elements from the list.
hotsiteIds	[Long!]	Filter the list by specific hotsite ids.
last	Int	Returns the last n elements from the list.
partnerAccessToken	String
sortDirection	SortDirection!
sortKey	HotsiteSortKeys!
menuGroups	[MenuGroup]	List of menu groups.
partnerAccessToken	String
position	String
url	String!
node	Node
id	ID!
nodes	[Node]
ids	[ID!]!
partners	PartnersConnection	List of partners.
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
names	[String]	Filter the list by specific names.
priceTableIds	[Int!]	Filter the list by specific price table ids.
sortDirection	SortDirection!
sortKey	PartnerSortKeys!
product	SingleProduct	Retrieve a product by the given id.
partnerAccessToken	String	The partner access token.
productId	Long!	The product ID.
productOptions ÔÜá´©Å	ProductOption	Options available for the given product. ÔÜá´©Å DEPRECATED Use the product query.
productId	Long!
productRecommendations	[Product]	Retrieve a list of recommended products by product id.
algorithm	ProductRecommendationAlgorithm!	Algorithm type.
partnerAccessToken	String	The partner access token.
productId	Long!	The product identifier.
quantity	Int!	The number of product recommendations.
products	ProductsConnection	Retrieve a list of products by specific filters.
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
filters	ProductExplicitFiltersInput!	The product filters to apply.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
partnerAccessToken	String	The partner access token.
sortDirection	SortDirection!
sortKey	ProductSortKeys!
scripts	[Script]	Retrieve a list of scripts.
name	String	The script name.
pageType	[ScriptPageType!]	The script page type list.
position	ScriptPosition	The script position.
url	String	Url for available scripts.
search	Search	Search products with cursor pagination.
operation	Operation!	The operation to perform between quuery terms.
partnerAccessToken	String	The partner access token.
query	String	The search query.
shippingQuotes	[ShippingQuote]	Get the shipping quotes by providing CEP and checkout or product identifier.
cep	CEP	CEP to get the shipping quotes.
checkoutId	Uuid	Checkout identifier to get the shipping quotes.
productVariantId	Long	Product identifier to get the shipping quotes.
shop	Shop	Store informations
shopSettings	[ShopSetting]	Store settings
settingNames	[String]	Setting names
uri	Uri	Get the URI kind.
url	String!

Mutation

Field	Type	Description
checkoutAddProduct	Checkout	Add products to an existing checkout
input	CheckoutProductInput!	Params to add products to an existing checkout
checkoutRemoveProduct	Checkout	Remove products from an existing checkout
input	CheckoutProductInput!	Params to remove products from an existing checkout
createCheckout	Checkout	Create a new checkout
products	[CheckoutProductItemInput]
createNewsletterRegister	NewsletterNode	Register an email in the newsletter.
input	NewsletterInput!
createProductReview	Review	Adds a review to a product variant.
input	ReviewCreateInput!
customerAccessTokenCreate	CustomerAccessToken	Creates a new customer access token with an expiration time.
input	CustomerAccessTokenInput!
customerAccessTokenRenew	CustomerAccessToken	Renews the expiration time of a customer access token. The token must not be expired.
customerAccessToken	String!
updateAddress	CustomerAddressNode	Change an existing address
address	CustomerAddressInput!
customerAccessToken	String!
id	ID	The customer address unique identifier.
wishlistAddProduct	[Product]	Adds a product to the customer's wishlist.
customerAccessToken	String!	A customer's access token
productId	Long!	ID of the product to be added to the customer's wishlist
wishlistRemoveProduct	[Product]	Removes a product from the customer's wishlist.
customerAccessToken	String!	A customer's access token
productId	Long!	ID of the product to be removed from the customer's wishlist

Objects

Attribute

Attributes available for the variant products from the given productId.

Field	Type	Description
attributeId	Long!	The id of the attribute.
displayType	String	The display type of the attribute.
id	ID	The node unique identifier.
name	String	The name of the attribute.
type	String	The type of the attribute.
values	[AttributeValue]	The values of the attribute.

AttributeMatrix

Field	Type	Description
column	AttributeMatrixInfo	Information about the column attribute.
data	[[AttributeMatrixProduct]]	The matrix products data. List of rows.
row	AttributeMatrixInfo	Information about the row attribute.

AttributeMatrixInfo

Field	Argument	Type	Description
displayType		String
name		String
values		[AttributeMatrixRowColumnInfoValue]

AttributeMatrixProduct

Field	Argument	Type	Description
available		Boolean!
productVariantId		Long!
stock		Long!

AttributeMatrixRowColumnInfoValue

Field	Argument	Type	Description
printUrl		String
value		String

AttributeSelection

Attributes available for the variant products from the given productId.

Field	Type	Description
canBeMatrix	Boolean!	Check if the current product attributes can be rendered as a matrix.
matrix	AttributeMatrix	Informations about the attribute matrix.
selectedVariant	ProductVariant	The selected variant given the current input filters. Variant may be from brother product Id.
selections	[AttributeSelectionOption]	Attributes available for the variant products from the given productId.

AttributeSelectionOption

Attributes available for the variant products from the given productId.

Field	Type	Description
attributeId	Long!	The id of the attribute.
displayType	String	The display type of the attribute.
name	String	The name of the attribute.
values	[AttributeSelectionOptionValue]	The values of the attribute.
varyByParent	Boolean!	If the attributes varies by parent.

AttributeSelectionOptionValue

Field	Type	Description
alias	String
available	Boolean!
printUrl	String
selected	Boolean!
value	String	The value of the attribute.

AttributeValue

Attributes values with variants

Field	Argument	Type	Description
productVariants		[ProductVariant]	Product variants that have the attribute.
value		String	The value of the attribute.

Autocomplete

Get query completion suggestion.

Field	Argument	Type	Description
products		[Product]	Suggested products based on the current query.
suggestions		[String]	List of possible query completions.

Banner

A banner is usually an image used to show sales, highlight products, announcements or to redirect to another page or hotsite on click.

Field	Type	Description
altText	String	Banner's alternative text.
bannerId	Long!	Banner unique identifier.
bannerName	String	Banner's name.
bannerUrl	String	URL where the banner is stored.
creationDate	DateTime	The date the banner was created.
displayOnAllPages	Boolean!	Field to check if the banner should be displayed on all pages.
displayOnCategories	Boolean!	Field to check if the banner should be displayed on category pages.
displayOnSearches	Boolean!	Field to check if the banner should be displayed on search pages.
displayOnWebsite	Boolean!	Field to check if the banner should be displayed on the website.
displayToPartners	Boolean!	Field to check if the banner should be displayed to partners.
height	Int	The banner's height in px.
id	ID	The node unique identifier.
openNewTab	Boolean!	Field to check if the banner URL should open in another tab on click.
order	Int!	The displaying order of the banner.
position	String	The displaying position of the banner.
searchTerms	[String]	A list of terms to display the banner on search.
title	String	The banner's title.
urlOnClick	String	URL to be redirected on click.
width	Int	The banner's width in px.

BannersConnection

A connection to a list of items.

Field	Type	Description
edges	[BannersEdge!]	A list of edges.
nodes	[Banner]	A flattened list of the nodes.
pageInfo	PageInfo!	Information to aid in pagination.

BannersEdge

An edge in a connection.

Field	Argument	Type	Description
cursor		String!	A cursor for use in pagination.
node		Banner	The item at the end of the edge.

BestInstallment

Field	Type	Description
discount	Boolean!	Wether the installment has discount.
displayName	String	The custom display name of the best installment plan option.
fees	Boolean!	Wether the installment has fees.
name	String	The name of the best installment plan option.
number	Int!	The number of installments.
value	Decimal!	The value of the installment.

Brand

Informations about brands and its products.

Field	Type	Description
active	Boolean!	If the brand is active at the platform.
alias	String	The alias for the brand's hotsite.
brandId	Long!	Brand unique identifier.
createdAt	DateTime!	The date the brand was created in the database.
id	ID	The node unique identifier.
name	String	The brand's name.
products	ProductsConnection	A list of products from the brand.
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
partnerAccessToken	String
sortDirection	SortDirection!
sortKey	ProductSortKeys!
updatedAt	DateTime!	The last update date.
urlCarrossel	String	A web address to be redirected.
urlLink	String	A web address linked to the brand.
urlLogo	String	The url of the brand's logo.

BrandsConnection

A connection to a list of items.

Field	Type	Description
edges	[BrandsEdge!]	A list of edges.
nodes	[Brand]	A flattened list of the nodes.
pageInfo	PageInfo!	Information to aid in pagination.
totalCount	Int!

BrandsEdge

An edge in a connection.

Field	Argument	Type	Description
cursor		String!	A cursor for use in pagination.
node		Brand	The item at the end of the edge.

Breadcrumb

Informations about breadcrumb.

Field	Argument	Type	Description
link		String	Breadcrumb link.
text		String	Breadcrumb text.

CategoriesConnection

A connection to a list of items.

Field	Type	Description
edges	[CategoriesEdge!]	A list of edges.
nodes	[Category]	A flattened list of the nodes.
pageInfo	PageInfo!	Information to aid in pagination.

CategoriesEdge

An edge in a connection.

Field	Argument	Type	Description
cursor		String!	A cursor for use in pagination.
node		Category	The item at the end of the edge.

Field	Argument	Type	Description
categoryId	Long!	Category unique identifier.
children	[Category]	A list of child categories, if it exists.
description	String	A description to the category.
displayMenu	Boolean!	Field to check if the category is displayed in the store's menu.
hotsiteAlias	String	The hotsite alias.
hotsiteUrl	String	The URL path for the category.
id	ID	The node unique identifier.
imageUrl	String	The url to access the image linked to the category.
imageUrlLink	String	The web address to access the image linked to the category.
name	String	The category's name.
parent	Category	The parent category, if it exists.
parentCategoryId	Long!	The parent category unique identifier.
position	Int!	The position the category will be displayed.
products	ProductsConnection	A list of products associated with the category.
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
partnerAccessToken	String
sortDirection	SortDirection!
sortKey	ProductSortKeys!
urlLink	String	A web address linked to the category.

Checkout

Field	Type	Description
cep	Int	The CEP.
checkoutId	Uuid!	The checkout unique identifier.
coupon	String	The coupon for discounts.
id	ID	The node unique identifier.
login	String
products	[CheckoutProductNode]	A list of products associated with the checkout.
shippingFee	Decimal!	The shipping fee.
subtotal	Decimal!	The subtotal value.
total	Decimal!	The total value.
updateDate	DateTime!	The last update date.
url	String	Url for the current checkout id.

CheckoutProductAttributeNode

Field	Type	Description
name	String	The attribute name
type	Int!	The attribute type
value	String	The attribute value

CheckoutProductNode

Field	Type	Description
ajustedPrice	Decimal!	The product adjusted price
brand	String	The product brand
category	String	The product category
gift	Boolean!	The product is a gift
googleCategory	[String]	The product Google category
imageUrl	String	The product URL image
informations	[String]	The product informations
installmentFee	Boolean!	The product installment fee
installmentValue	Decimal!	The product installment value
listPrice	Decimal!	The product list price
name	String	The product name
numberOfInstallments	Int!	The product number of installments
price	Decimal!	The product price
productAttributes	[CheckoutProductAttributeNode]	The product attributes
productId	Long!	The product unique identifier.
productVariantId	Long!	The product variant unique identifier.
quantity	Int!	The product quantity
shippingDeadline	CheckoutShippingDeadlineNode	The product shipping deadline
sku	String	The product SKU
url	String	The product URL

CheckoutShippingDeadlineNode

Field	Type	Description
deadline	Int!	The shipping deadline
description	String	The shipping description
secondDescription	String	The shipping second description
secondTitle	String	The shipping second title
title	String	The shipping title

Content

Contents are used to show things to the user.

Field	Type	Description
content	String	The content in html to be displayed.
contentId	Long!	Content unique identifier.
creationDate	DateTime	The date the content was created.
height	Int	The content's height in px.
id	ID	The node unique identifier.
position	String	The content's position.
searchTerms	[String]	A list of terms to display the content on search.
title	String	The content's title.
width	Int	The content's width in px.

ContentsConnection

A connection to a list of items.

Field	Type	Description
edges	[ContentsEdge!]	A list of edges.
nodes	[Content]	A flattened list of the nodes.
pageInfo	PageInfo!	Information to aid in pagination.

ContentsEdge

An edge in a connection.

Field	Argument	Type	Description
cursor		String!	A cursor for use in pagination.
node		Content	The item at the end of the edge.

Customer

A customer from the store.

Field	Type	Description
birthDate	DateTime!	Customer's birth date.
businessPhoneNumber	String	Customer's business phone number.
cnpj	String	Taxpayer identification number for businesses.
companyName	String	Entities legal name.
cpf	String	Brazilian individual taxpayer registry identification.
creationDate	DateTime!	Creation Date.
customerId	Long!	Customer's unique identifier.
customerName	String	Customer's name.
customerType	String	Indicates if it is a natural person or company profile.
deliveryAddress	CustomerAddressNode	Customer's delivery address.
email	String	Customer's email address.
gender	String	Customer's gender.
id	ID	The node unique identifier.
mobilePhoneNumber	String	Customer's mobile phone number.
ordersStatistics	CustomerOrdersStatistics	Statistics about the orders the customer made in a specific timeframe.
dateGte	DateTime	Filter que customer orders by date greater than or equal the specified date.
dateLt	DateTime	Filter que customer orders by date lesser than the specified date.
onlyPaidOrders	Boolean!	Toggle to apply the statistics only on orders with paid status.
partnerId	Long	The partner id which the order was made with.
partners	[CustomerPartnerNode]	Get info about the associated partners.
phoneNumber	String	Customer's phone number.
residencialAddress	CustomerAddressNode	Customer's residencial address.
responsibleName	String	Responsible's name.
rg	String	Registration number Id.
stateRegistration	String	State registration number.
updateDate	DateTime!	Date of the last update.
wishlist	wishlist	Customer wishlist.

CustomerAccessToken

Field	Argument	Type	Description
token		String
validUntil		DateTime!

CustomerAddressNode

Field	Type	Description
active	Boolean!	If the address is active or not.
addressDetails	String	Address details.
addressNumber	String	Address number.
cep	String	zip code.
city	String	address city.
country	String	Country.
email	String	The email of the customer address.
id	ID	The node unique identifier.
name	String	The name of the customer address.
neighborhood	String	Address neighborhood.
phone	String	The phone of the customer address.
referencePoint	String	Address reference point.
state	String	State.
street	String	Address street.

CustomerOrdersStatistics

Field	Argument	Type	Description
productsQuantity		Int!	The number of products the customer made from the number of orders.
quantity		Int!	The number of orders the customer made.

CustomerPartnerNode

Field	Type	Description
alias	String	The partner alias.
name	String	The partner's name.
partnerAccessToken	String	The partner's access token.

Customization

Some products can have customizations, such as writing your name on it or other predefined options.

Field	Type	Description
cost	Decimal!	Cost of customization.
customizationId	Long!	Customization unique identifier.
groupName	String	Customization group's name.
id	ID	The node unique identifier.
name	String	The customization's name.
order	Int!	Priority order of customization.
type	String	Type of customization.
values	[String]	Value of customization.

Hotsite

A hotsite is a group of products used to organize them or to make them easier to browse.

Field	Type	Description
banners	[Banner]	A list of banners associated with the hotsite.
contents	[Content]	A list of contents associated with the hotsite.
endDate	DateTime	The hotsite will be displayed until this date.
expression	String	Expression used to associate products to the hotsite.
hotsiteId	Long!	Hotsite unique identifier.
id	ID	The node unique identifier.
name	String	The hotsite's name.
pageSize	Int!	Set the quantity of products displayed per page.
products	ProductsConnection	A list of products associated with the hotsite.
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
sortDirection	SortDirection!
sortKey	ProductSortKeys!
sorting	HotsiteSorting	Sorting information to be used by default on the hotsite.
startDate	DateTime	The hotsite will be displayed from this date.
subtype	HotsiteSubtype	The subtype of the hotsite.
template	String	The template used for the hotsite.
url	String	The hotsite's URL.

HotsiteSorting

Field	Argument	Type	Description
direction		SortDirection
field		ProductSortKeys

HotsitesConnection

A connection to a list of items.

Field	Type	Description
edges	[HotsitesEdge!]	A list of edges.
nodes	[Hotsite]	A flattened list of the nodes.
pageInfo	PageInfo!	Information to aid in pagination.

HotsitesEdge

An edge in a connection.

Field	Argument	Type	Description
cursor		String!	A cursor for use in pagination.
node		Hotsite	The item at the end of the edge.

Image

Informations about an image of a product.

Field	Type	Description
fileName	String	The name of the image file.
mini	Boolean!	Check if the image is used for the product main image.
order	Int!	Numeric order the image should be displayed.
print	Boolean!	Check if the image is used for the product prints only.
url	String	The url to retrieve the image

Information

Information registred to the product.

Field	Type	Description
id	Long!	The information id.
title	String	The information title.
type	String	The information type.
value	String	The information value.

Installment

Field	Type	Description
discount	Boolean!	Wether the installment has discount.
fees	Boolean!	Wether the installment has fees.
number	Int!	The number of installments.
value	Decimal!	The value of the installment.

InstallmentPlan

Field	Type	Description
displayName	String	The custom display name of this installment plan.
installments	[Installment]	List of the installments.
name	String	The name of this installment plan.

Field	Type	Description
cssClass	String	Menu css class to apply.
id	ID	The node unique identifier.
imageUrl	String	Menu image url address.
level	Int!	Menu hierarchy level.
link	String	Menu link address.
menuGroupId	Int!	Menu group identifier.
menuId	Int!	Menu identifier.
name	String!	Menu name.
openNewTab	Boolean!	Menu hierarchy level.
order	Int!	Menu position order.
parentMenuId	Int	Parent menu identifier.
text	String	Menu extra text.

MenuGroup

Informations about menu groups.

Field	Type	Description
id	ID	The node unique identifier.
imageUrl	String	Menu group image url.
menuGroupId	Int!	Menu group identifier.
menus	[Menu]	List of menus associated with the current group
name	String	Menu group name.
partnerId	Int	Menu group partner id.
position	String	Menu group position.

NewsletterNode

Field	Type	Description
createDate	DateTime!	Newsletter creation date.
email	String	The newsletter receiver email.
name	String	The newsletter receiver name.
updateDate	DateTime	Newsletter update date.

PageInfo

Information about pagination in a connection.

Field	Type	Description
endCursor	String	When paginating forwards, the cursor to continue.
hasNextPage	Boolean!	Indicates whether more edges exist following the set defined by the clients arguments.
hasPreviousPage	Boolean!	Indicates whether more edges exist prior the set defined by the clients arguments.
startCursor	String	When paginating backwards, the cursor to continue.

Partner

Partners are used to assign specific products or price tables depending on its scope.

Field	Type	Description
alias	String	The partner alias.
endDate	DateTime!	The partner is valid until this date.
id	ID	The node unique identifier.
logoUrl	String	The pertner logo's URL.
name	String	The partner's name.
origin	String	The partner's origin.
partnerAccessToken	String	The partner's access token.
partnerId	Long!	Partner unique identifier.
portfolioId	Int!	Portfolio identifier assigned to this partner.
priceTableId	Int!	Price table identifier assigned to this partner.
startDate	DateTime!	The partner is valid from this date.
type	String	The type of scoped the partner is used.

PartnersConnection

A connection to a list of items.

Field	Type	Description
edges	[PartnersEdge!]	A list of edges.
nodes	[Partner]	A flattened list of the nodes.
pageInfo	PageInfo!	Information to aid in pagination.

PartnersEdge

An edge in a connection.

Field	Argument	Type	Description
cursor		String!	A cursor for use in pagination.
node		Partner	The item at the end of the edge.

PriceRange

Range of prices for this product.

Field	Argument	Type	Description
quantity		Int!	The quantity of products in this range.
range		String	The price range.

PriceTable

Field	Type	Description
discountPercentage	Decimal!	The amount of discount in percentage.
id	Long!	The id of this price table.
listPrice	Decimal	The listed regular price of this table.
price	Decimal!	The current working price of this table.

Prices

The prices of the product.

Field	Type	Description
bestInstallment	BestInstallment	The best installment option available.
discountPercentage	Decimal!	The amount of discount in percentage.
discounted	Boolean!	Wether the current price is discounted.
installmentPlans	[InstallmentPlan]	List of the possibles installment plans.
listPrice	Decimal	The listed regular price of the product.
multiplicationFactor	Float!	The multiplication factor used for items that are sold by quantity.
price	Decimal!	The current working price.
priceTables	[PriceTable]	List of the product different price tables. Only returned when using the partnerAccessToken or public price tables.

Product

A product represents an item for sale in the store.

Field	Type	Description
addToCartFromSpot	Boolean	Check if the product can be added to cart directly from spot.
alias	String	The product url alias.
attributes	[ProductAttribute]	List of the product attributes.
available	Boolean	Field to check if the product is available in stock.
averageRating	Int	The product average rating. From 0 to 5.
condition	String	The product condition.
createdAt	DateTime	The product creation date.
deadline	Int	The product delivery deadline.
display	Boolean	Check if the product should be displayed.
displayOnlyPartner	Boolean	Check if the product should be displayed only for partners.
displaySearch	Boolean	Check if the product should be displayed on search.
ean	String	The product's unique EAN.
freeShipping	Boolean	Check if the product offers free shipping.
id	ID	The node unique identifier.
images	[Image]	List of the product images.
height	Int	The height of the image the url will return.
width	Int	The width of the image the url will return.
informations	[Information]	List of the product insformations.
mainVariant	Boolean	Check if its the main variant.
minimumOrderQuantity	Int	The product minimum quantity for an order.
newRelease	Boolean	Check if the product is a new release.
numberOfVotes	Int	The number of votes that the average rating consists of.
parentId	Long	Parent product unique identifier.
prices	Prices	The product prices.
productBrand	ProductBrand	Summarized informations about the brand of the product.
productCategories	[ProductCategory]	Summarized informations about the categories of the product.
productId	Long	Product unique identifier.
productName	String	The product name.
productSubscription	ProductSubscription	Summarized informations about the subscription of the product.
productVariantId	Long	Variant unique identifier.
promotions	[Promotion]	List of promotions this product belongs to.
similarProducts	[SimilarProduct]	List of similar products.
sku	String	The product's unique SKU.
spotAttributes	[String]	The values of the spot attribute.
spotInformation	String	The product spot information.
spotlight	Boolean	Check if the product is on spotlight.
stock	Long	The available stock at the default distribution center.
stocks	[Stock]	List of the product stocks on different distribution centers.
subscriptionGroups	[SubscriptionGroup]	List of subscription groups this product belongs to.
telesales	Boolean	Check if the product is a telesale.
updatedAt	DateTime	The product last update date.
variantName	String	The variant name.

ProductAggregations

Field	Type	Description
filters	[SearchFilter]	List of product filters which can be used to filter subsequent queries.
maximumPrice	Decimal!	Minimum price of the products.
minimumPrice	Decimal!	Maximum price of the products.
priceRanges	[PriceRange]	List of price ranges for the selected products.

ProductAttribute

The attributes of the product.

Field	Type	Description
attributeId	Long!	The id of the attribute.
displayType	String	The display type of the attribute.
id	ID	The node unique identifier.
name	String	The name of the attribute.
type	String	The type of the attribute.
value	String	The value of the attribute.

ProductBrand

Field	Type	Description
alias	String	The hotsite url alias fot this brand.
id	Long!	The brand id.
logoUrl	String	The url that contains the brand logo image.
name	String	The name of the brand.

ProductCategory

Information about the category of a product.

Field	Type	Description
active	Boolean!	Wether the category is currently active.
googleCategories	String	The categories in google format.
hierarchy	String	The category hierarchy.
id	Int!	The id of the category.
main	Boolean!	Wether this category is the main category for this product.
name	String	The category name.
url	String	The category hotsite url alias.

ProductCollectionSegment

Field	Argument	Type	Description
items		[Product]
page		Int!
pageSize		Int!
totalCount		Int!

ProductOption

Options available for the given product.

Field	Type	Description
attributes	[Attribute]	A list of attributes available for the given product and its variants.
filter	[AttributeFilterInput]
customizations	[Customization]	A list of customizations available for the given products.
id	ID	The node unique identifier.

ProductSubscription

Field	Type	Description
discount	Decimal!	The amount of discount if this product is sold as a subscription.
price	Decimal	The price of the product when sold as a subscription.
subscriptionOnly	Boolean!	Wether this product is sold only as a subscrition.

ProductVariant

Product variants that have the attribute.

Field	Type	Description
alias	String	The product alias.
available	Boolean	Field to check if the product is available in stock.
id	ID	The node unique identifier.
images	[Image]	The product's images.
height	Int	The height of the image the url will return.
width	Int	The width of the image the url will return.
prices	Prices	The product prices.
productId	Long	Product unique identifier.
productVariantId	Long	Variant unique identifier.
stock	Long	The available stock at the default distribution center.

ProductsConnection

A connection to a list of items.

Field	Type	Description
edges	[ProductsEdge!]	A list of edges.
nodes	[Product]	A flattened list of the nodes.
pageInfo	PageInfo!	Information to aid in pagination.
totalCount	Int!

ProductsEdge

An edge in a connection.

Field	Argument	Type	Description
cursor		String!	A cursor for use in pagination.
node		Product	The item at the end of the edge.

Promotion

Information about promotions of a product.

Field	Type	Description
content	String	The promotion html content.
id	Long!	The promotion id.
stamp	String	The stamp of the promotion.
title	String	The promotion title.

Review

A product review written by a customer.

Field	Type	Description
customer	String	The reviewer name.
email	String	The reviewer e-mail.
rating	Int!	The review rating.
review	String	The review content.
reviewDate	DateTime!	The review date.

SEO

Entity SEO information.

Field	Type	Description
content	String	Content of SEO.
httpEquiv	String	Equivalent SEO type for HTTP.
name	String	Name of SEO.
scheme	String	Scheme for SEO.
type	String	Type of SEO.

Script

Returns the scripts registered in the script manager.

Field	Type	Description
content	String	The script content.
name	String	The script name.
pageType	ScriptPageType!	The script page type.
position	ScriptPosition!	The script position.
priority	Int!	The script priority.

Search

Search for relevant products to the searched term.

Field	Type	Description
aggregations	ProductAggregations	Aggregations from the products.
banners	[Banner]	A list of banners displayed in search pages.
breadcrumbs	[Breadcrumb]	List of search breadcrumbs.
contents	[Content]	A list of contents displayed in search pages.
forbiddenTerm	forbiddenTerm	Information about forbidden term.
products	ProductsConnection	A cursor based paginated list of products from the search.
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
filters	[ProductFilterInput]	List of filters. Check filters result for available inputs.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
maximumPrice	Decimal	Maximum price filter.
minimumPrice	Decimal	Minimum price filter.
onlyMainVariant	Boolean!	Toggle the return of only main variants.
sortDirection	SortDirection!
sortKey	ProductSearchSortKeys!
productsByOffset	ProductCollectionSegment	An offset based paginated list of products from the search.
filters	[ProductFilterInput]	List of filters. Check filters result for available inputs.
limit	Int!	The number of products to return.
maximumPrice	Decimal	Maximum price filter.
minimumPrice	Decimal	Minimum price filter.
offset	Int!	The offset used to paginate.
onlyMainVariant	Boolean!	Toggle the return of only main variants.
sortDirection	SortDirection!
sortKey	ProductSearchSortKeys!
redirectUrl	String	Redirection url in case a term in the search triggers a redirect.
searchTime	String	Time taken to perform the search.

SearchFilter

Aggregated filters of a list of products.

Field	Type	Description
field	String	The name of the field.
origin	String	The origin of the field.
values	[SearchFilterItem]	List of the values of the field.

SearchFilterItem

Details of a filter value.

Field	Argument	Type	Description
name		String	The name of the value.
quantity		Int!	The quantity of product with this value.

ShippingProduct

The product informations related to the shipping.

Field	Argument	Type	Description
productVariantId		Int!	The product unique identifier.
value		Float!	The shipping value related to the product.

ShippingQuote

A shipping quote.

Field	Type	Description
deadline	Int!	The shipping deadline.
id	ID	The node unique identifier.
name	String	The shipping name.
products	[ShippingProduct]	The products related to the shipping.
shippingQuoteId	Uuid!	The shipping quote unique identifier.
type	String	The shipping type.
value	Float!	The shipping value.

Shop

Informations about the store.

Field	Type	Description
checkoutUrl	String	Checkout URL
mainUrl	String	Store main URL
mobileCheckoutUrl	String	Mobile checkout URL
mobileUrl	String	Mobile URL
name	String	Store name

ShopSetting

Store setting.

Field	Argument	Type	Description
name		String	Setting name
value		String	Setting value

SimilarProduct

Information about a similar product.

Field	Type	Description
alias	String	The url alias of this similar product.
image	String	The file name of the similar product image.
name	String	The name of the similar product.

SingleHotsite

A hotsite is a group of products used to organize them or to make them easier to browse.

Field	Type	Description
aggregations	ProductAggregations	Aggregations from the products.
banners	[Banner]	A list of banners associated with the hotsite.
breadcrumbs	[Breadcrumb]	A list of breadcrumbs for the hotsite.
contents	[Content]	A list of contents associated with the hotsite.
endDate	DateTime	The hotsite will be displayed until this date.
expression	String	Expression used to associate products to the hotsite.
hotsiteId	Long!	Hotsite unique identifier.
id	ID	The node unique identifier.
name	String	The hotsite's name.
pageSize	Int!	Set the quantity of products displayed per page.
products	ProductsConnection	A list of products associated with the hotsite. Cursor pagination.
after	String	Returns the elements in the list that come after the specified cursor.
before	String	Returns the elements in the list that come before the specified cursor.
filters	[ProductFilterInput]	List of filters. Check filters result for available inputs.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
maximumPrice	Decimal	Maximum price filter.
minimumPrice	Decimal	Minimum price filter.
onlyMainVariant	Boolean!	Toggle the return of only main variants.
partnerAccessToken	String	The partner access token.
sortDirection	SortDirection
sortKey	ProductSortKeys
productsByOffset	ProductCollectionSegment	A list of products associated with the hotsite. Offset pagination.
filters	[ProductFilterInput]	List of filters. Check filters result for available inputs.
limit	Int!	The number of products to return.
maximumPrice	Decimal	Maximum price filter.
minimumPrice	Decimal	Minimum price filter.
offset	Int!	The offset used to paginate.
onlyMainVariant	Boolean!	Toggle the return of only main variants.
partnerAccessToken	String	The partner access token.
sortDirection	SortDirection
sortKey	ProductSortKeys
seo	[SEO]	A list of SEO contents associated with the hotsite.
sorting	HotsiteSorting	Sorting information to be used by default on the hotsite.
startDate	DateTime	The hotsite will be displayed from this date.
subtype	HotsiteSubtype	The subtype of the hotsite.
template	String	The template used for the hotsite.
url	String	The hotsite's URL.

SingleProduct

A product represents an item for sale in the store.

Field	Type	Description
addToCartFromSpot	Boolean	Check if the product can be added to cart directly from spot.
alias	String	The product url alias.
attributeSelections	AttributeSelection	Information about the possible selection attributes.
selected	[AttributeFilterInput]
attributes	[ProductAttribute]	List of the product attributes.
available	Boolean	Field to check if the product is available in stock.
averageRating	Int	The product average rating. From 0 to 5.
breadcrumbs	[Breadcrumb]	List of product breadcrumbs.
buyTogether	[SingleProduct]	Buy together products.
condition	String	The product condition.
createdAt	DateTime	The product creation date.
customizations	[Customization]	A list of customizations available for the given products.
deadline	Int	The product delivery deadline.
display	Boolean	Check if the product should be displayed.
displayOnlyPartner	Boolean	Check if the product should be displayed only for partners.
displaySearch	Boolean	Check if the product should be displayed on search.
ean	String	The product's unique EAN.
freeShipping	Boolean	Check if the product offers free shipping.
id	ID	The node unique identifier.
images	[Image]	List of the product images.
height	Int	The height of the image the url will return.
width	Int	The width of the image the url will return.
informations	[Information]	List of the product insformations.
mainVariant	Boolean	Check if its the main variant.
minimumOrderQuantity	Int	The product minimum quantity for an order.
newRelease	Boolean	Check if the product is a new release.
numberOfVotes	Int	The number of votes that the average rating consists of.
parentId	Long	Parent product unique identifier.
prices	Prices	The product prices.
productBrand	ProductBrand	Summarized informations about the brand of the product.
productCategories	[ProductCategory]	Summarized informations about the categories of the product.
productId	Long	Product unique identifier.
productName	String	The product name.
productSubscription	ProductSubscription	Summarized informations about the subscription of the product.
productVariantId	Long	Variant unique identifier.
promotions	[Promotion]	List of promotions this product belongs to.
reviews	[Review]	List of customer reviews for this product.
seo	[SEO]	Product SEO informations.
similarProducts	[SimilarProduct]	List of similar products.
sku	String	The product's unique SKU.
spotAttributes	[String]	The values of the spot attribute.
spotInformation	String	The product spot information.
spotlight	Boolean	Check if the product is on spotlight.
stock	Long	The available stock at the default distribution center.
stocks	[Stock]	List of the product stocks on different distribution centers.
subscriptionGroups	[SubscriptionGroup]	List of subscription groups this product belongs to.
telesales	Boolean	Check if the product is a telesale.
updatedAt	DateTime	The product last update date.
variantName	String	The variant name.

Stock

Information about a product stock in a particular distribution center.

Field	Type	Description
id	Long!	The id of the distribution center.
items	Long!	The number of physical items in stock at this DC.
name	String	The name of the distribution center.

SubscriptionGroup

Field	Type	Description
recurringTypes	[SubscriptionRecurringType]	The recurring types for this subscription group.
status	String	The status name of the group.
statusId	Int!	The status id of the group.
subscriptionGroupId	Long!	The subscription group id.
subscriptionOnly	Boolean!	Wether the product is only avaible for subscription.

SubscriptionRecurringType

Field	Type	Description
days	Int!	The number of days of the recurring type.
name	String	The recurring type display name.
recurringTypeId	Long!	The recurring type id.

Uri

Node of URI Kind.

Field	Type	Description
hotsiteSubtype	HotsiteSubtype	The origin of the hotsite.
kind	UriKind!	Path kind.
partnerSubtype	PartnerSubtype	The partner subtype.
productAlias	String	Product alias.
productCategoriesIds	[Int!]	Product categories IDs.
redirectCode	String	Redirect status code.
redirectUrl	String	Url to redirect.

forbiddenTerm

Informations about a forbidden search term.

Field	Argument	Type	Description
suggested		String	The suggested search term instead.
text		String	The text to display about the term.

wishlist

Field	Argument	Type	Description
products		[Product]	Wishlist products.

Inputs

AttributeFilterInput

Field		Type	Description
attributeId		Long!
value		String!

AttributeInput

Input to specify which attributes to match.

Field	Type	Description
id	[Long!]	The attribute Ids to match.
name	[String]	The attribute name to match.
type	[String]	The attribute type to match.
value	[String]	The attribute value to match

BrandFilterInput

Filter brand results based on giving attributes.

Field		Type	Description
brandIds		[Long!]	Its unique identifier (you may provide a list of IDs if needed).
names		[String]	The set of brand names which the result item name must be included in.

CheckoutCustomizationInput

Field		Type	Description
customizationId		Long!
value		String

CheckoutProductInput

Field		Type	Description
id		Uuid!
products		[CheckoutProductItemInput]!

CheckoutProductItemInput

Field		Type	Description
customization		[CheckoutCustomizationInput]
productVariantId		Long!
quantity		Int!
subscription		CheckoutSubscriptionInput

CheckoutSubscriptionInput

Field		Type	Description
recurringTypeId		Int!
subscriptionGroupId		Long!

CustomerAccessTokenInput

The input to authenticate a user.

Field		Type	Description
email		String!
password		String!

CustomerAddressInput

Field		Type	Description
addressDetails		String
addressNumber		String
cep		CEP
city		String
country		CountryCode
email		EmailAddress
name		String
neighborhood		String
phone		String
referencePoint		String
state		String
street		String

NewsletterInput

Field		Type	Description
email		String!
name		String!
recaptchaToken		String!

PricesInput

Input to specify the range of prices to return.

Field	Type	Description
discounted	Boolean	Return only products where the listed price is more than the price.
price_gte	Decimal	The product price must be greater than or equal to.
price_lte	Decimal	The product price must be lesser than or equal to.

ProductExplicitFiltersInput

Filter product results based on giving attributes.

Field	Type	Description
attributes	AttributeInput	The set of attributes do filter.
available	Boolean	Choose if you want to retrieve only the available products in stock.
brandId	[Long!]	The set of brand IDs which the result item brand ID must be included in.
categoryId	[Long!]	The set of category IDs which the result item category ID must be included in.
ean	[String]	The set of EANs which the result item EAN must be included.
hasImages	Boolean	Retrieve the product variant only if it contains images.
mainVariant	Boolean	Retrieve the product variant only if it is the main product variant.
prices	PricesInput	The set of prices to filter.
productId	[Long!]	The product unique identifier (you may provide a list of IDs if needed).
productVariantId	[Long!]	The product variant unique identifier (you may provide a list of IDs if needed).
sku	[String]	The set of SKUs which the result item SKU must be included.
stock_gte	Long	Show products with a quantity of available products in stock greater than or equal to the given number.
stock_lte	Long	Show products with a quantity of available products in stock less than or equal to the given number.
updatedAt_gte	String	Retrieve products which the last update date is greater than or equal to the given date.
updatedAt_lte	String	Retrieve products which the last update date is less than or equal to the given date.

ProductFilterInput

Custom attribute defined on store's admin may also be used as a filter.

Field		Type	Description
field		String!	The attribute name.
values		[String]!	The set of values which the result filter item value must be included in.

ReviewCreateInput

Review input parameters.

Field	Type	Description
email	String!	The reviewer's email.
name	String!	The reviewer's name.
productVariantId	Long!	The product variant id to add the review to.
rating	Int!	The review rating.
recaptchaToken	String!	The google recatpcha token.
review	String!	The review content.

Enums

ApplyPolicy

Value	Description
BEFORE_RESOLVER
AFTER_RESOLVER

BannerSortKeys

Define the banner attribute which the result set will be sorted on.

Value	Description
ID	The banner's unique identifier.
CREATION_DATE	The banner's creation date.

BrandSortKeys

Define the brand attribute which the result set will be sorted on.

Value	Description
ID	The brand unique identifier.
NAME	The brand name.

CategorySortKeys

Define the category attribute which the result set will be sorted on.

Value	Description
ID	The category unique identifier.
NAME	The category name.

ContentSortKeys

Define the content attribute which the result set will be sorted on.

Value	Description
ID	The content's unique identifier.
CreationDate	The content's creation date.

HotsiteSortKeys

Define the hotsite attribute which the result set will be sorted on.

Value	Description
ID	The hotsite id.
NAME	The hotsite name.
URL	The hotsite url.

HotsiteSubtype

Value	Description
CATEGORY	Hotsite created from a category.
BRAND	Hotsite created from a brand.
PORTFOLIO	Hotsite created from a portfolio.
BUY_LIST	Hotsite created from a buy list (lista de compra).

Operation

Types of operations to perform between query terms.

Value	Description
AND	Performs AND operation between query terms.
OR	Performs OR operation between query terms.

PartnerSortKeys

Define the partner attribute which the result set will be sorted on.

Value	Description
ID	The partner unique identifier.
NAME	The partner name.

PartnerSubtype

Value	Description
OPEN	Partner 'open' subtype.
CLOSED	Partner 'closed' subtype.
CLIENT	Partner 'client' subtype.

ProductRecommendationAlgorithm

Value	Description
DEFAULT

ProductSearchSortKeys

Define the product attribute which the result set will be sorted on.

Value	Description
RELEVANCE	The relevance that the search engine gave to the possible result item based on own criteria.
NAME	The product name.
SALES	The sales number on a period of time.
PRICE	The product variant price.
DISCOUNT	The applied discount to the product variant price.
RANDOM	Sort in a random way.
RELEASE_DATE	The date the product was released.
STOCK	The quantity in stock of the product variant.

ProductSortKeys

Define the product attribute which the result set will be sorted on.

Value	Description
NAME	The product name.
SALES	The sales number on a period of time.
PRICE	The product variant price.
DISCOUNT	The applied discount to the product variant price.
RANDOM	Sort in a random way.
RELEASE_DATE	The date the product was released.
STOCK	The quantity in stock of the product variant.

ScriptPageType

Value	Description
ALL
HOME
SEARCH
CATEGORY
BRAND
PRODUCT

ScriptPosition

Value	Description
HEADER_START
HEADER_END
BODY_START
BODY_END
FOOTER_START
FOOTER_END

SortDirection

Define the sort orientation of the result set.

Value	Description
ASC	The results will be sorted in an ascending order.
DESC	The results will be sorted in an descending order.

UriKind

Value	Description
PRODUCT
HOTSITE
REDIRECT
NOT_FOUND
PARTNER

Scalars

Boolean

The Boolean scalar type represents true or false.

CEP

Represents a CEP

CountryCode

String representing a country code

DateTime

The DateTime scalar represents an ISO-8601 compliant date time type.

Decimal

The built-in Decimal scalar type.

EmailAddress

The EmailAddress scalar type constitutes a valid email address, represented as a UTF-8 character sequence. The scalar follows the specification defined by the HTML Spec https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address.

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Long

The Long scalar type represents non-fractional signed whole 64-bit numeric values. Long can represent values between -(2^63) and 2^63 - 1.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Uuid

Interfaces

Node

Field	Argument	Type	Description
id		ID

Updated 5 months ago