diff --git a/docs/faststore/docs/faststore-api/schema/enums.mdx b/docs/faststore/docs/faststore-api/schema/enums.mdx new file mode 100644 index 0000000000..47160e2e56 --- /dev/null +++ b/docs/faststore/docs/faststore-api/schema/enums.mdx @@ -0,0 +1,195 @@ +--- +title: 'Enums' +--- + +### StoreCollectionType + +Product collection type. Possible values are `Department`, `Category`, `Brand`, `Cluster`, `SubCategory` or `Collection`. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
Department + +First level of product categorization. + +
Category + +Second level of product categorization. + +
SubCategory + +Third level of product categorization. + +
Brand + +Product brand. + +
Cluster + +Product cluster. + +
Collection + +Product collection. + +
+ +### StoreFacetType + +Search facet type. + + + + + + + + + + + + + + + + +
ValueDescription
BOOLEAN + +Indicates a filter with boolean options (e.g., `yes` and `no`), for narrowing search results. + +
RANGE + +Indicates a filter to choose between a range of values (e.g., `price`, `size`, etc) to refine search results. + +
+ +### StoreSort + +Product search results sorting options. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
price_desc + +Sort by price, from highest to lowest. + +
price_asc + +Sort by price, from lowest to highest. + +
orders_desc + +Sort by orders, from highest to lowest. + +
name_desc + +Sort by name, in reverse alphabetical order. + +
name_asc + +Sort by name, in alphabetical order. + +
release_desc + +Sort by release date, from highest to lowest. + +
discount_desc + +Sort by discount value, from highest to lowest. + +
score_desc + +Sort by product score, from highest to lowest. + +
+ +### StoreStatus + +Status used to indicate a message type. For instance, a shopping cart informative or error message. + + + + + + + + + + + + + + + + + + + + +
ValueDescription
INFOIndicates non-critical notifications or informative messages related to the user's action.
WARNINGIndicates a potential issue or unexpected behavior that might require user attention but doesn't necessarily prevent them from continuing.
ERRORIndicates a critical issue that prevents the user from completing an action or indicates a problem with the system.
diff --git a/docs/faststore/docs/faststore-api/schema/inputs.mdx b/docs/faststore/docs/faststore-api/schema/inputs.mdx new file mode 100644 index 0000000000..62811db46a --- /dev/null +++ b/docs/faststore/docs/faststore-api/schema/inputs.mdx @@ -0,0 +1,724 @@ +--- +title: 'Inputs' +--- + +### IGeoCoordinates + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
latitudeFloat! + +The latitude of the geographic coordinates. + +
longitudeFloat! + +The longitude of the geographic coordinates. + +
+ +### IPersonNewsletter + +Person data input to the newsletter. + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
nameString! + +Person's name. + +
emailString! + +Person's email. + +
+ +### IShippingItem + +Shipping Simulation item input. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idString! + +ShippingItem ID / Sku. + +
quantityInt! + +Number of items. + +
sellerString! + +Seller responsible for the ShippingItem. + +
+ +### IStoreCart + +Shopping cart input. + + + + + + + + + + + + + + + + +
FieldTypeDescription
orderIStoreOrder! + +Order information, including `orderNumber`, `acceptedOffer` and `shouldSplitItem`. + +
+ +### IStoreCurrency + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
codeString! + +Currency code (e.g: USD). + +
symbolString! + +Currency symbol (e.g: $). + +
+ +### IStoreDeliveryMode + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
deliveryChannelString! + +The delivery channel information of the session. + +
deliveryMethodString! + +The delivery method information of the session. + +
deliveryWindowIStoreDeliveryWindow + +The delivery window information of the session. + +
+ +### IStoreDeliveryWindow + +Delivery window information. + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
startDateString! + +The delivery window start date information. + +
endDateString! + +The delivery window end date information. + +
+ +### IStoreGeoCoordinates + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
latitudeFloat! + +The latitude of the geographic coordinates. + +
longitudeFloat! + +The longitude of the geographic coordinates. + +
+ +### IStoreImage + +Image input. + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
urlString! + +Image input URL. + +
alternateNameString! + +Alias for the input image. + +
+ +### IStoreOffer + +Offer input. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
priceFloat! + +Also known as spot price. + +
listPriceFloat! + +This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf. + +
sellerIStoreOrganization! + +Seller responsible for the offer. + +
itemOfferedIStoreProduct! + +Information on the item being offered. + +
quantityInt! + +Number of items offered. + +
+ +### IStoreOrder + +Order input. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
orderNumberString! + +ID of the order in [VTEX order management](https://help.vtex.com/en/tutorial/license-manager-resources-oms--60QcBsvWeum02cFi3GjBzg#). + +
acceptedOffer[IStoreOffer!]! + +Array with information on each accepted offer. + +
shouldSplitItemBoolean + +Indicates whether or not items with attachments should be split. + +
+ +### IStoreOrganization + +Organization input. + + + + + + + + + + + + + + + + +
FieldTypeDescription
identifierString! + +Organization ID. + +
+ +### IStorePerson + +Client profile data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idString! + +Client ID. + +
emailString! + +Client email. + +
givenNameString! + +Client first name. + +
familyNameString! + +Client last name. + +
+ +### IStoreProduct + +Product input. Products are variants within product groups, equivalent to VTEX [SKUs](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
skuString! + +Stock Keeping Unit. Merchant-specific ID for the product. + +
nameString! + +Product name. + +
image[IStoreImage!]! + +Array of product images. + +
additionalProperty[IStorePropertyValue!] + +Custom Product Additional Properties. + +
+ +### IStorePropertyValue + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
propertyIDString + +Property id. This propert changes according to the content of the object. + +
valueObjectOrString! + +Property value. May hold a string or the string representation of an object. + +
nameString! + +Property name. + +
valueReferenceString! + +Specifies the nature of the value + +
+ +### IStoreSelectedFacet + +Selected search facet input. + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
keyString! + +Selected search facet key. + +
valueString! + +Selected search facet value. + +
+ +### IStoreSession + +Session input. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
localeString! + +Session input locale. + +
currencyIStoreCurrency! + +Session input currency. + +
countryString! + +Session input country. + +
channelString + +Session input channel. + +
deliveryModeIStoreDeliveryMode + +Session input delivery mode. + +
addressTypeString + +Session input address type. + +
postalCodeString + +Session input postal code. + +
geoCoordinatesIStoreGeoCoordinates + +Session input geoCoordinates. + +
personIStorePerson + +Session input person. + +
diff --git a/docs/faststore/docs/faststore-api/schema/mutations.mdx b/docs/faststore/docs/faststore-api/schema/mutations.mdx new file mode 100644 index 0000000000..057fc10604 --- /dev/null +++ b/docs/faststore/docs/faststore-api/schema/mutations.mdx @@ -0,0 +1,97 @@ +--- +title: "Mutations" +--- + +## Cart + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
validateCartStoreCart + +Checks for changes between the cart presented in the UI and the cart stored in the ecommerce platform. If changes are detected, it returns the cart stored on the platform. Otherwise, it returns `null`. + +
cartIStoreCart! + +Shopping cart input. + +
sessionIStoreSession + +Web session identifier. + +
+ +## Session + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
validateSessionStoreSession + +Updates a web session with the specified values. + +
sessionIStoreSession! + +Web session identifier. + +
searchString!
subscribeToNewsletterPersonNewsletter + +Subscribes a new person to the newsletter list. + +
dataIPersonNewsletter!Person data input to the newsletter.
diff --git a/docs/faststore/docs/faststore-api/schema/objects.mdx b/docs/faststore/docs/faststore-api/schema/objects.mdx index 61081fffc9..29bbfe4f68 100644 --- a/docs/faststore/docs/faststore-api/schema/objects.mdx +++ b/docs/faststore/docs/faststore-api/schema/objects.mdx @@ -1,7 +1,2993 @@ --- title: 'Objects' -sidebar_label: 'API Extensions' -slug: objects --- -> ⚠️ This documentation is currently under development. +## Objects + +### Address + +Address information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
postalCodeString + +Address postal code. + +
cityString + +Address city. + +
stateString + +Address state. + +
countryString + +Address country. + +
streetString + +Address street. + +
numberString + +Address number. + +
neighborhoodString + +Address neighborhood. + +
complementString + +Address complement. + +
referenceString + +Address reference. + +
geoCoordinates[Float] + +Address geoCoordinates. + +
+ +### AvailableDeliveryWindows + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
startDateUtcString + +Available delivery window start date in UTC. + +
endDateUtcString + +Available delivery window end date in UTC. + +
priceInt + +Available delivery window price. + +
listPriceInt + +Available delivery window list price. + +
taxInt + +Available delivery window tax. + +
+ +### DeliveryIds + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
courierIdString + +DeliveryIds courier id. + +
warehouseIdString + +DeliveryIds warehouse id. + +
dockIdString + +DeliveryIds dock id. + +
courierNameString + +DeliveryIds courier name. + +
quantityInt + +DeliveryIds quantity. + +
+ +### LogisticsInfo + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
itemIndexString + +LogisticsInfo itemIndex. + +
selectedSlaString + +LogisticsInfo selectedSla. + +
slas[ShippingSLA] + +List of LogisticsInfo ShippingSLA. + +
+ +### LogisticsItem + +Shipping Simulation Logistic Item. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
idString + +LogisticsItem ID or SKU. + +
requestIndexInt
quantityInt + +Number of items. + +
sellerString + +Seller responsible for the ShippingItem. + +
sellerChain[String] + +List of Sellers. + +
taxInt + +LogisticsItem tax. + +
priceValidUntilString + +Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time. + +
priceInt + +LogisticsItem price. + +
listPriceInt + +LogisticsItem listPrice. + +
rewardValueInt + +LogisticsItem rewardValue. + +
sellingPriceInt + +LogisticsItem sellingPrice. + +
measurementUnitString + +LogisticsItem measurementUnit. + +
unitMultiplierInt + +LogisticsItem unitMultiplier. + +
availabilityString + +LogisticsItem availability. + +
+ +### MessageFields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
itemIndexString + +MessageFields item index. + +
eanString + +MessageFields ean. + +
skuNameString + +MessageFields sku name. + +
+ +### MessageInfo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
codeString + +MessageInfo code. + +
textString + +MessageInfo text. + +
statusString + +MessageInfo status. + +
fieldsMessageFields + +MessageInfo fields. + +
+ +### PersonNewsletter + +Newsletter information. + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
idString! + +Person's ID in the newsletter list. + +
+ +### PickupAddress + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
addressTypeString + +PickupAddress address type. + +
receiverNameString + +PickupAddress receiver name. + +
addressIdString + +PickupAddress address id. + +
postalCodeString + +PickupAddress postal code. + +
cityString + +PickupAddress city. + +
stateString + +PickupAddress state. + +
countryString + +PickupAddress country. + +
streetString + +PickupAddress street. + +
numberString + +PickupAddress number. + +
neighborhoodString + +PickupAddress neighborhood. + +
complementString + +PickupAddress complement. + +
referenceString + +PickupAddress reference. + +
geoCoordinates[Float] + +PickupAddress geo coordinates. + +
+ +### PickupStoreInfo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
friendlyNameString + +PickupStoreInfo friendly name. + +
addressPickupAddress + +PickupStoreInfo address. + +
additionalInfoString + +PickupStoreInfo additional information. + +
dockIdString + +PickupStoreInfo dock id. + +
isPickupStoreBoolean + +Information if the store has pickup enable. + +
+ +### SearchMetadata + +Search result. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
isTermMisspelledBoolean! + +Indicates if the search term was misspelled. + +
logicalOperatorString! + +Logical operator used to run the search. + +
fuzzyString! + +Indicates how the search engine corrected the misspelled word by using fuzzy logic. + +
+ +### SellerInfo + +Information of sellers. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
idString + +Identification of the seller. + +
nameString + +Name of the seller. + +
logoString + +Logo of the seller. + +
+ +### SellersData + +Regionalization with sellers information. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
idString + +Identification of region. + +
sellers[SellerInfo] + +List of sellers. + +
+ +### ShippingData + +Shipping Simulation information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
items[LogisticsItem] + +List of LogisticsItem. + +
logisticsInfo[LogisticsInfo] + +List of LogisticsInfo. + +
messages[MessageInfo] + +List of MessageInfo. + +
addressAddress + +Address information. + +
+ +### ShippingSLA + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
idString + +ShippingSLA id. + +
nameString + +ShippingSLA name. + +
priceFloat + +ShippingSLA price. + +
shippingEstimateString + +ShippingSLA shipping estimate. + +
localizedEstimatesString + +ShippingSLA localized shipping estimate. +Note: this will always return a localized string for locale `en-US`. + +
availableDeliveryWindows[AvailableDeliveryWindows] + +ShippingSLA available delivery windows. + +
shippingEstimateDateString + +ShippingSLA shipping estimate date. + +
deliveryIds[DeliveryIds] + +List of ShippingSLA delivery ids. + +
deliveryChannelString + +ShippingSLA delivery channel. + +
friendlyNameString + +ShippingSLA friendly name. + +
carrierString + +ShippingSLA carrier. + +
pickupPointIdString + +ShippingSLA pickup point id. + +
pickupStoreInfoPickupStoreInfo + +ShippingSLA pickup store info. + +
pickupDistanceFloat + +ShippingSLA pickup distance. + +
+ +### SkuVariants + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
activeVariationsActiveVariations + +SKU property values for the current SKU. + +
allVariantsByNameVariantsByName + +All available options for each SKU variant property, indexed by their name. + +
slugsMapSlugsMap + +Maps property value combinations to their respective SKU's slug. Enables +us to retrieve the slug for the SKU that matches the currently selected +variations in O(1) time. +If `dominantVariantName` is not present, the first variant will be +considered the dominant one. + +
dominantVariantNameString
availableVariationsFormattedVariants + +Available options for each varying SKU property, taking into account the +`dominantVariantName` property. Returns all available options for the +dominant property, and only options that can be combined with its current +value for other properties. +If `dominantVariantName` is not present, the first variant will be +considered the dominant one. + +
dominantVariantNameString
+ +### StoreAggregateOffer + +Aggregate offer information, for a given SKU that is available to be fulfilled by multiple sellers. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
highPriceFloat! + +Highest price among all sellers. + +
lowPriceFloat! + +Lowest price among all sellers. + +
offerCountInt! + +Number of sellers selling this SKU. + +
priceCurrencyString! + +ISO code of the currency used for the offer prices. + +
offers[StoreOffer!]! + +Array with information on each available offer. + +
+ +### StoreAggregateRating + +Average rating, based on multiple ratings or reviews. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
ratingValueFloat! + +Value of the aggregate rating. + +
reviewCountInt! + +Total number of ratings. + +
+ +### StoreAuthor + +information about the author of a product review or rating. + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
nameString! + +Author name. + +
+ +### StoreBrand + +Brand of a given product. + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
nameString! + +Brand name. + +
+ +### StoreBreadcrumbList + +List of items consisting of chain linked web pages, ending with the current page. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
itemListElement[StoreListItem!]! + +Array with breadcrumb elements. + +
numberOfItemsInt! + +Number of breadcrumbs in the list. + +
+ +### StoreCart + +Shopping cart information. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
orderStoreOrder! + +Order information, including `orderNumber` and `acceptedOffer`. + +
messages[StoreCartMessage!]! + +List of shopping cart messages. + +
+ +### StoreCartMessage + +Shopping cart message. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
textString! + +Shopping cart message text. + +
statusStoreStatus! + +Shopping cart message status, which can be `INFO`, `WARNING` or `ERROR`. + +
+ +### StoreCollection + +Product collection information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
seoStoreSeo! + +Meta tag data. + +
breadcrumbListStoreBreadcrumbList! + +List of items consisting of chain linked web pages, ending with the current page. + +
metaStoreCollectionMeta! + +Collection meta information. Used for search. + +
idID! + +Collection ID. + +
slugString! + +Corresponding collection URL slug, with which to retrieve this entity. + +
typeStoreCollectionType! + +Collection type. + +
+ +### StoreCollectionConnection + +Collection connections, including pagination information and collections returned by the query. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
pageInfoStorePageInfo! + +Collection pagination information. + +
edges[StoreCollectionEdge!]! + +Array with collection connection page edges, each containing a collection and a corresponding cursor. + +
+ +### StoreCollectionEdge + +Each collection edge contains a `node`, with product collection information, and a `cursor`, that can be used as a reference for pagination. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
nodeStoreCollection! + +Each collection node contains the information of a product collection returned by the query. + +
cursorString! + +Collection cursor. Used as pagination reference. + +
+ +### StoreCollectionFacet + +Product collection facet, used for search. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
keyString! + +Facet key. + +
valueString! + +Facet value. + +
+ +### StoreCollectionMeta + +Collection meta information. Used for search. + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
selectedFacets[StoreCollectionFacet!]! + +List of selected collection facets. + +
+ +### StoreCurrency + +Currency information. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
codeString! + +Currency code (e.g: `USD`). + +
symbolString! + +Currency symbol (e.g: `$`). + +
+ +### StoreDeliveryMode + +Delivery mode information. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
deliveryChannelString! + +The delivery channel information of the session. + +
deliveryMethodString! + +The delivery method information of the session. + +
deliveryWindowStoreDeliveryWindow + +The delivery window information of the session. + +
+ +### StoreDeliveryWindow + +Delivery window information. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
startDateString! + +The delivery window start date information. + +
endDateString! + +The delivery window end date information. + +
+ +### StoreFacetBoolean + +Search facet boolean information. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
keyString! + +Facet key. + +
labelString! + +Facet label. + +
values[StoreFacetValueBoolean!]! + +Array with information on each facet value. + +
+ +### StoreFacetRange + +Search facet range information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
keyString! + +Facet key. + +
labelString! + +Facet label. + +
minStoreFacetValueRange! + +Minimum facet range value. + +
maxStoreFacetValueRange! + +Maximum facet range value. + +
+ +### StoreFacetValueBoolean + +Information of a specific facet value. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
valueString! + +Facet value. + +
labelString! + +Facet value label. + +
selectedBoolean! + +Indicates whether facet is selected. + +
quantityInt! + +Number of items with this facet. + +
+ +### StoreFacetValueRange + +Search facet range value information. Used for minimum and maximum range values. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
absoluteFloat! + +Search facet range absolute value. + +
selectedFloat! + +Search facet range selected value. + +
+ +### StoreGeoCoordinates + +Geographic coordinates information. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
latitudeFloat! + +The latitude of the geographic coordinates. + +
longitudeFloat! + +The longitude of the geographic coordinates. + +
+ +### StoreImage + +Image. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
urlString! + +Image URL. + +
alternateNameString! + +Alias for the image. + +
+ +### StoreListItem + +Item of a list. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
itemString! + +List item value. + +
nameString! + +Name of the list item. + +
positionInt! + +Position of the item in the list. + +
+ +### StoreOffer + +Offer information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
listPriceFloat! + +This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf. + +
sellingPriceFloat! + +Computed price before applying coupons, taxes or benefits. This may change before it reaches the shelf. + +
priceCurrencyString! + +ISO code of the currency used for the offer prices. + +
priceFloat! + +Also known as spot price. + +
priceValidUntilString! + +Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time. + +
itemConditionString! + +Offer item condition. + +
availabilityString! + +Offer item availability. + +
sellerStoreOrganization! + +Seller responsible for the offer. + +
itemOfferedStoreProduct! + +Information on the item being offered. + +
quantityInt! + +Number of items offered. + +
+ +### StoreOrder + +Information of a specific order. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
orderNumberString! + +ID of the order in [VTEX order management](https://help.vtex.com/en/tutorial/license-manager-resources-oms--60QcBsvWeum02cFi3GjBzg#). + +
acceptedOffer[StoreOffer!]! + +Array with information on each accepted offer. + +
+ +### StoreOrganization + +Organization. + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
identifierString! + +Organization ID. + +
+ +### StorePageInfo + +Whenever you make a query that allows for pagination, such as `allProducts` or `allCollections`, you can check `StorePageInfo` to learn more about the complete set of items and use it to paginate your queries. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
hasNextPageBoolean! + +Indicates whether there is at least one more page with items after the ones returned in the current query. + +
hasPreviousPageBoolean! + +Indicates whether there is at least one more page with items before the ones returned in the current query. + +
startCursorString! + +Cursor corresponding to the first possible item. + +
endCursorString! + +Cursor corresponding to the last possible item. + +
totalCountInt! + +Total number of items (products or collections), not pages. + +
+ +### StorePerson + +Client profile data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
idString! + +Client ID. + +
emailString! + +Client email. + +
givenNameString! + +Client first name. + +
familyNameString! + +Client last name. + +
+ +### StoreProduct + +Product information. Products are variants within product groups, equivalent to VTEX [SKUs](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
seoStoreSeo! + +Meta tag data. + +
breadcrumbListStoreBreadcrumbList! + +List of items consisting of chain linked web pages, ending with the current page. + +
slugString! + +Corresponding collection URL slug, with which to retrieve this entity. + +
nameString! + +Product name. + +
productIDString! + +Product ID, such as [ISBN](https://www.isbn-international.org/content/what-isbn) or similar global IDs. + +
brandStoreBrand! + +Product brand. + +
descriptionString! + +Product description. + +
image[StoreImage!]! + +Array of images. + +
contextString
limitInt
offersStoreAggregateOffer! + +Aggregate offer information. + +
skuString! + +Stock Keeping Unit. Merchant-specific ID for the product. + +
gtinString! + +Global Trade Item Number. + +
review[StoreReview!]! + +Array with review information. + +
aggregateRatingStoreAggregateRating! + +Aggregate ratings data. + +
isVariantOfStoreProductGroup! + +Indicates product group related to this product. + +
additionalProperty[StorePropertyValue!]! + +Array of additional properties. + +
releaseDateString! + +The product's release date. Formatted using ISO 8601. + +
+ +### StoreProductConnection + +Product connections, including pagination information and products returned by the query. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
pageInfoStorePageInfo! + +Product pagination information. + +
edges[StoreProductEdge!]! + +Array with product connection edges, each containing a product and a corresponding cursor. + +
+ +### StoreProductEdge + +Each product edge contains a `node`, with product information, and a `cursor`, that can be used as a reference for pagination. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
nodeStoreProduct! + +Each product node contains the information of a product returned by the query. + +
cursorString! + +Product cursor. Used as pagination reference. + +
+ +### StoreProductGroup + +Product group information. Product groups are catalog entities that may contain variants. They are equivalent to VTEX [Products](https://help.vtex.com/en/tutorial/what-is-a-product--2zrB2gFCHyQokCKKE8kuAw#), whereas each variant is equivalent to a VTEX [SKU](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
hasVariant[StoreProduct!]! + +Array of variants related to product group. Variants are equivalent to VTEX [SKUs](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). + +
productGroupIDString! + +Product group ID. + +
nameString! + +Product group name. + +
additionalProperty[StorePropertyValue!]! + +Array of additional properties. + +
skuVariantsSkuVariants + +Object containing data structures to facilitate handling different SKU +variant properties. Specially useful for implementing SKU selection +components. + +
+ +### StorePropertyValue + +Properties that can be associated with products and products groups. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
propertyIDString! + +Property id. This propert changes according to the content of the object. + +
valueObjectOrString! + +Property value. May hold a string or the string representation of an object. + +
nameString! + +Property name. + +
valueReferenceString! + +Specifies the nature of the value. + +
+ +### StoreRedirect + +Redirect informations, including url returned by the query. +https://schema.org/Thing + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
urlString + +URL to redirect. + +
+ +### StoreReview + +Information of a given review. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
reviewRatingStoreReviewRating! + +Review rating information. + +
authorStoreAuthor! + +Review author. + +
+ +### StoreReviewRating + +Information of a given review rating. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
ratingValueFloat! + +Rating value. + +
bestRatingFloat! + +Best rating value. + +
+ +### StoreSearchResult + +Search result. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
productsStoreProductConnection! + +Search result products. + +
facets[StoreFacet!]! + +Array of search result facets. + +
suggestionsStoreSuggestions! + +Search result suggestions. + +
metadataSearchMetadata + +Search result metadata. Additional data can be used to send analytics events. + +
+ +### StoreSeo + +Search Engine Optimization (SEO) tags data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
titleString! + +Title tag. + +
titleTemplateString! + +Title template tag. + +
descriptionString! + +Description tag. + +
canonicalString! + +Canonical tag. + +
+ +### StoreSession + +Session information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
localeString! + +Session locale. + +
currencyStoreCurrency! + +Session currency. + +
countryString! + +Session country. + +
channelString + +Session channel. + +
deliveryModeStoreDeliveryMode + +Session delivery mode. + +
addressTypeString + +Session address type. + +
postalCodeString + +Session postal code. + +
geoCoordinatesStoreGeoCoordinates + +Session input geoCoordinates. + +
personStorePerson + +Session input person. + +
+ +### StoreSuggestionTerm + +Suggestion term. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
valueString! + +The term. + +
countInt! + +Its occurrences count. + +
+ +### StoreSuggestions + +Suggestions information. + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
terms[StoreSuggestionTerm!]! + +Array with suggestion terms. + +
products[StoreProduct!]! + +Array with suggestion products' information. + +
diff --git a/docs/faststore/docs/faststore-api/schema/queries.mdx b/docs/faststore/docs/faststore-api/schema/queries.mdx index 81e713d905..41b2122400 100644 --- a/docs/faststore/docs/faststore-api/schema/queries.mdx +++ b/docs/faststore/docs/faststore-api/schema/queries.mdx @@ -1,7 +1,304 @@ --- -title: 'Queries' -sidebar_label: 'API Extensions' -slug: queries +title: "Queries" --- -> ⚠️ This documentation is currently under development. +Arguments must be provided by the user. + +Arguments preeceded by an exclamation mark (`!`) are not nullable. + +## Product + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
productStoreProduct! + +Returns the details of a product based on the specified locator. + +
locator[IStoreSelectedFacet!]! + +An array of selected search facets. + +
allProductsStoreProductConnection! + +Returns information about all products. + +
firstInt! + +Product pagination argument, indicating how many items should be returned from the complete result list. + +
afterString + +Product pagination argument, indicating the cursor corresponding with the item after which the items should be fetched. + +
+ +## Collection + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
collectionStoreCollection! + +Returns the details of a collection based on the collection slug. + +
slugString! + +Collection slug. + +
allCollectionsStoreCollectionConnection! + +Returns information about all collections. + +
firstInt! + +Collection pagination argument, indicating how many items should be returned from the complete result list. + +
afterString + +Collection pagination argument, indicating the cursor corresponding with the item after which the items should be fetched. + +
+ +## Search + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
searchStoreSearchResult! + +Returns the result of a product, facet, or suggestion search. + +
firstInt! + +Search pagination argument, indicating how many results should be returned from the complete result list. + +
afterString + +Search pagination argument, indicating the cursor corresponding with the item after which the results should be fetched. + +
sortStoreSort + +Search results sorting mode. + +
termString + +Search term. + +
selectedFacets[IStoreSelectedFacet!] + +Array of selected search facets. + +
redirectStoreRedirect + +Returns if there's a redirect for a search. + +
termString + +Search term. + +
selectedFacets[IStoreSelectedFacet!] + +Array of selected search facets. + +
+ +## Shipping + + + + + + + + + + + + + + + + + + + + + + + + +
shippingShippingData + +Returns information about shipping simulation. + +
items[IShippingItem!]! + +Shipping Simulation item input. + +
postalCodeString! + +Postal code to freight calculator. + +
countryString! + +Country of postal code. + +
+ +## Sellers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
sellersSellersData + +Returns a list of sellers available for a specific localization. + +
postalCodeString + +Postal code input to calculate sellers. + +
geoCoordinatesIGeoCoordinates + +Geocoordinates input to calculate sellers. + +
countryString! + +Country of localization. + +
salesChannelString + +Sales channel of the navigation. + +
diff --git a/docs/faststore/docs/faststore-api/schema/scalars.mdx b/docs/faststore/docs/faststore-api/schema/scalars.mdx new file mode 100644 index 0000000000..cb35e03c82 --- /dev/null +++ b/docs/faststore/docs/faststore-api/schema/scalars.mdx @@ -0,0 +1,97 @@ +--- +title: 'Scalars' +--- + +## Scalars + +### ActiveVariations + +The `ActiveVariations` scalar type represents a combination of active product variations. + +Example: + +```json +{ + Color: 'Red', Size: '42' +} +``` + +### Boolean + +The `Boolean` scalar type represents `true` or `false`. + +### Float + +The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). + +### FormattedVariants + +The `FormattedVariants` scalar type represents a collection of product variations with additional details like image source, description, and values. + +Example: + +```json +{ + Color: [ + { + src: "https://storecomponents.vtexassets.com/...", + alt: "...", + label: "...", + value: "..." + }, + { + src: "https://storecomponents.vtexassets.com/...", + alt: "...", + label: "...", + value: "..." + } + ], + Size: [ + { + src: "https://storecomponents.vtexassets.com/...", + alt: "...", + label: "...", + value: "..." + } + ] +} +``` + +### 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. + +### ObjectOrString + +A string or the string representation of an object (a stringified object). + +### SlugsMap + +Example: + +```json +{ + 'Color-Red-Size-40': 'classic-shoes-37' +} +``` + +### 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. + +### VariantsByName + +The `VariantsByName` scalar type represents a collection of variations listed by their names, like a list of available `Color` options or `Size` options. + +Example: + +```json +{ + Color: [ "Red", "Blue", "Green" ], + Size: [ "40", "41" ] +} +```