Queryable objects

Objects in GraphQL represent the resources that you can access. Objects can contain a list of fields, which are specifically typed. For example, the Product object has a field called name, which is a String.

Category#

Represents information about a category to classify the product, such as the category name etc. It is also important to note that there are only two levels of parent / child classification in this schema.

FieldArgumentTypeDescription
idID!

Specifies the category to update, or creates a new category if one doesn't exist.

archivedAtDatetime

The date and time when the category was archived.

updatedAtDatetime!

The date and time when the category was last updated.

createdAtDatetime!

The date and time when the category was added to the store.

nameString!

The category name.

formattedNameString!

The combination of the name of the parent category with the name of this category.

colorString!

The category color.

lockedBoolean!

Specifies if this category can be edited (name and color).

parentCategory

The parent category of this category.

shopShop!

The shop associated to this category.

CategoryConnection#

FieldArgumentTypeDescription
edges[CategoryEdge!]!

A list of edges.

pageInfoCategoryPageInfo!

Information to aid in pagination.

totalCountInt!

The total number of elements.

CategoryEdge#

FieldArgumentTypeDescription
cursorString!

A marker for an edge's position in the connection

nodeCategory!

An object with an ID to support global identification.

CategoryPageInfo#

FieldArgumentTypeDescription
startCursorString

A start cursor for use in pagination.

endCursorString

An end cursor for use in pagination.

hasPreviousPageBoolean

Whether the result has a previous page.

hasNextPageBoolean

Whether the result has a next page.

Device#

Represents information about a device used to make operations at the shop, such as the device brand, locale and model.

FieldArgumentTypeDescription
idID!

Specifies the device to update, or creates a new device if one doesn't exist.

archivedAtDatetime

The date and time when the device was archived.

updatedAtDatetime!

The date and time when the device was last updated.

createdAtDatetime!

The date and time when the device was added to the store.

nameString!

The device name.

slugString!

The device slug.

uidString!

The device unique identifier.

localeString

The device specific region.

userAgentString

The device user agent identification.

brandString

The device brand.

modelString

The device model.

systemVersionString

The device system version.

shopShop!

The shop associated with this device.

DeviceConnection#

FieldArgumentTypeDescription
edges[DeviceEdge!]!

A list of edges.

pageInfoDevicePageInfo!

Information to aid in pagination.

totalCountInt!

The total number of elements.

DeviceEdge#

FieldArgumentTypeDescription
cursorString!

A marker for an edge's position in the connection

nodeDevice!

An object with an ID to support global identification.

DevicePageInfo#

FieldArgumentTypeDescription
startCursorString

A start cursor for use in pagination.

endCursorString

An end cursor for use in pagination.

hasPreviousPageBoolean

Whether the result has a previous page.

hasNextPageBoolean

Whether the result has a next page.

Price#

Represents the price lists proposed by the store.

FieldArgumentTypeDescription
idID!

Specifies the price to update, or creates a new price if one doesn't exist.

archivedAtDatetime

The date and time when the price was archived.

updatedAtDatetime!

The date and time when the price was last updated.

createdAtDatetime!

The date and time when the price was added to the store.

nameString!

The price name.

enableByDefaultBoolean!

Specifies if this price will be enabled by default.

taxIncludedBoolean!

Specifies if this price will include taxes.

shopShop!

The shop associated with this price.

PriceConnection#

FieldArgumentTypeDescription
edges[PriceEdge!]!

A list of edges.

pageInfoPricePageInfo!

Information to aid in pagination.

totalCountInt!

The total number of elements.

PriceEdge#

FieldArgumentTypeDescription
cursorString!
nodePrice!

An object with an ID to support global identification.

PricePageInfo#

FieldArgumentTypeDescription
startCursorString

A start cursor for use in pagination.

endCursorString

An end cursor for use in pagination.

hasPreviousPageBoolean

Whether the result has a previous page.

hasNextPageBoolean

Whether the result has a next page.

Product#

Represents information about a product of the shop, such as the product name, their category and producer.

FieldArgumentTypeDescription
idID!

Specifies the product to update, or creates a new product if one doesn't exist.

archivedAtDatetime

The date and time when the product was archived.

updatedAtDatetime!

The date and time when the product was last updated.

createdAtDatetime!

The date and time when the product was added to the store.

nameString!

The product name.

designationString

The product designation.

colorProductColor

The color.

kindProductKind!

The product kind. It is defined as one of the following options: spirituous, wine, beer or simple.

familyString

The product family.

producerString

The product producer.

countryString

The country where the product comes from.

regionString

The region where the product comes from.

beerTypeString

The beer type when the product has the kind property equal to beer.

wineTypeProductWineType

The wine type when the product has the kind property equal to wine. It is defined as one of the following options: still or effervescent.

whiteWineTypeProductWhiteWineType

The wine type when the product has the kind property equal to wine. It is defined as one of the following options: dry, semidry, soft or sweet.

internalNoteString

An internal note about the product.

formattedDescriptionString

A formatted description of the product.

formattedOriginString

A formatted origin (producer, region, country) of the product.

taxTax

A tax assigned to the product.

categoryCategory

A category assigned to the product.

variantsVariantConnection!

A list of variants assigned to the product.

firstInt

Returns up to the first n elements from the list.

lastInt

Returns up to the last n elements from the list.

beforeString

Returns the elements that come before the specified cursor.

afterString

Returns the elements that come after the specified cursor.

shopShop!

The shop associated with this product.

ProductConnection#

FieldArgumentTypeDescription
edges[ProductEdge!]!

A list of edges.

pageInfoProductPageInfo!

Information to aid in pagination.

totalCountInt!

The total number of elements.

ProductEdge#

FieldArgumentTypeDescription
cursorString!
nodeProduct!

An object with an ID to support global identification.

ProductPageInfo#

FieldArgumentTypeDescription
startCursorString

A start cursor for use in pagination.

endCursorString

An end cursor for use in pagination.

hasPreviousPageBoolean

Whether the result has a previous page.

hasNextPageBoolean

Whether the result has a next page.

Shop#

Represents information about the shop.

FieldArgumentTypeDescription
idID!

Specifies the Shop to update, or creates a new Shop if one doesn't exist.

archivedAtDatetime

The date and time when the Shop was archived.

updatedAtDatetime!

The date and time when the Shop was last updated.

createdAtDatetime!

The date and time when the Shop was added to the store.

nameString!

The shop name.

logoString

The shop logo.

addressString!

The shop address.

postalCodeString!

The shop postal code.

cityString!

The shop city.

phoneNumberString

The shop phone number.

emailString

The shop email.

websiteString

The shop website.

fiscalYearEndClosingMonthString

Represents to the completion of a one-year, or 12-month, accounting period.

corporateNameString

The shop corporate name.

legalRepresentativeString

The shop legal representative.

legalFormString

The legal type of the shop (e.g: SAS, SARL ...).

amountOfShareCapitalString

The amount of share capital of the shop.

tvaNumberString

The shop TVA number.

siretNumberString

The shop SIRET number.

rcsNumberString

The shop RCS number.

apeNafCodeString

The shop code APE / NAF.

bankNameString

The shop bank name.

bankCodeString

The shop bank code.

bankAccountHolderString

The bank account holder of the shop.

bankAccountNumberString

The bank account number of the shop.

bicCodeString

The BIC Code of the shop.

ibanNumberString

The IBAN number of the shop.

logoUriString

The uri of the shop logo.

StockActivity#

Represents information about a stock activity of the shop, such as the kind, their quantity and variant related.

FieldArgumentTypeDescription
idID!

Specifies the stockActivity to update, or creates a new stockActivity if one doesn't exist.

archivedAtDatetime

The date and time when the stock activity was archived.

updatedAtDatetime!

The date and time when the stock activity was last updated.

createdAtDatetime!

The date and time when the stock activity was added to the store.

formattedLabelString!

The stock activity formatted label.

formattedQuantityString!

The stock activity formatted quantity.

kindStockActivityKind!

The type of this stock activity. Some types can increment the stock, others can decrement it or reset it.

quantityInt!

The quantity associated to this stock activity.

commentString

A comment about this stock activity.

reasonStockActivityLossReason

Represents the possible reasons why the stockActivity was classified as a LOSS.

stockKeepingUnitString

A unique identifier assigned to each activity.

capacityUnitString

The unit used in this stock activity (kg, cl, L, g, ...).

capacityPrecisionInt

The decimal accuracy of stock activity capacity.

variantVariant

The variant reference.

deviceDevice!

The device associated to this stock activity.

shopShop!

The shop associated to this stock activity.

StockActivityConnection#

FieldArgumentTypeDescription
edges[StockActivityEdge!]!

A list of edges.

pageInfoStockActivityPageInfo!

Information to aid in pagination.

totalCountInt!

The total number of elements.

StockActivityEdge#

FieldArgumentTypeDescription
cursorString!

A marker for an edge's position in the connection

nodeStockActivity!

An object with an ID to support global identification.

StockActivityPageInfo#

FieldArgumentTypeDescription
startCursorString

A start cursor for use in pagination.

endCursorString

An end cursor for use in pagination.

hasPreviousPageBoolean

Whether the result has a previous page.

hasNextPageBoolean

Whether the result has a next page.

Tax#

taxes - Represents information relating to indirect taxes on the consumption of products sold by the shop (e.g. "TVA" in France).

FieldArgumentTypeDescription
idID!

Specifies the tax to update, or creates a new tax if one doesn't exist.

archivedAtDatetime

The date and time when the tax was archived.

updatedAtDatetime!

The date and time when the tax was last updated.

createdAtDatetime!

The date and time when the tax was added to the store.

nameString!

The tax name.

valueFloat!

The tax value.

shopShop!

The shop associated to this tax.

TaxConnection#

FieldArgumentTypeDescription
edges[TaxEdge!]!

A list of edges.

pageInfoTaxPageInfo!

Information to aid in pagination.

totalCountInt!

The total number of elements.

TaxEdge#

FieldArgumentTypeDescription
cursorString!

A marker for an edge's position in the connection

nodeTax!

An object with an ID to support global identification.

TaxPageInfo#

FieldArgumentTypeDescription
startCursorString

A start cursor for use in pagination.

endCursorString

An end cursor for use in pagination.

hasPreviousPageBoolean

Whether the result has a previous page.

hasNextPageBoolean

Whether the result has a next page.

Variant#

variants - Represents information about a variant of a product, such as the variant name, their price, etc.

FieldArgumentTypeDescription
idID!

Specifies the variant to update, or creates a new variant if one doesn't exist.

archivedAtDatetime

The date and time when the variant was archived.

updatedAtDatetime!

The date and time when the variant was last updated.

createdAtDatetime!

The date and time when the variant was added to the store.

stockKeepingUnitString

A unique identifier assigned to each variant.

nameString!

The variant name.

activeBoolean!

Specifies if this variant is active for sale or not.

formattedNameString!

The combination of the name of the parent product and the name of the variant child.

formattedDescriptionString!

The combination of the name, color, producer, region and country of the parent product.

formattedStatusVariantStatus!

The status of the variant.

formattedCategoryString!

Represents the category formattedName field.

purchasedPriceFloat

The variant purchased price.

yearInt

The variant year.

capacity ⚠️Float

The variant capacity.

⚠️ DEPRECATED

This attribute has been replaced by capacityValue.

capacityValueFloat

The variant capacity

capacityUnitString

The variant capacity unit (kg, cl, L, g, ...).

capacityPrecisionInt

The variant capacity precision.

alcoholVolumeFloat

The variant alcohol volume.

stockVariantStock!

The variant stock.

ean13String

The variant European Article Number

bulkBoolean

Specifies if this variant is sold in bulk or not.

internalNoteString

An internal note about the variant.

tastingNoteString

A note about the variant taste.

productProduct

A product assigned to the variant.

stockActivitiesStockActivityConnection!

A list of stock activities assigned to the variant.

variantPricesVariantPriceConnection!

A list of prices assigned to the variant.

firstInt

Returns up to the first n elements from the list.

lastInt

Returns up to the last n elements from the list.

beforeString

Returns the elements that come before the specified cursor.

afterString

Returns the elements that come after the specified cursor.

orderProductsOrderProdutConnection!

A list of order products assigned to the variant.

firstInt

Returns up to the first n elements from the list.

lastInt

Returns up to the last n elements from the list.

beforeString

Returns the elements that come before the specified cursor.

afterString

Returns the elements that come after the specified cursor.

shopShop!

The shop associated with this variant.

VariantConnection#

FieldArgumentTypeDescription
edges[VariantEdge!]!

A list of edges.

pageInfoVariantPageInfo!

Information to aid in pagination.

totalCountInt!

The total number of elements.

VariantEdge#

FieldArgumentTypeDescription
cursorString!

A marker for an edge's position in the connection

nodeVariant!

An object with an ID to support global identification.

VariantPageInfo#

FieldArgumentTypeDescription
startCursorString

A start cursor for use in pagination.

endCursorString

An end cursor for use in pagination.

hasPreviousPageBoolean

Whether the result has a previous page.

hasNextPageBoolean

Whether the result has a next page.

VariantPrice#

variantPrices - Represents the selling price list of product variants.

FieldArgumentTypeDescription
idID!

Specifies the instance of VariantPrice to update, or creates a new instance of VariantPrice if one doesn't exist.

archivedAtDatetime

The date and time when the instance of VariantPrice was archived.

updatedAtDatetime!

The date and time when the instance of VariantPrice was last updated.

createdAtDatetime!

The date and time when the instance of VariantPrice was added to the store.

valueIncludingTaxFloat!

The variant price value including tax.

valueExcludingTaxFloat!

The variant price value excluding tax.

fromQuantityFloat

The minimum quantity for this variant price.

toQuantityFloat

The maximum quantity for this variant price.

pricePrice

The price reference.

variantVariant

The variant reference.

shopShop!

The shop associated with this variant price.

VariantPriceConnection#

FieldArgumentTypeDescription
edges[VariantPriceEdge!]!

A list of edges.

pageInfoVariantPricePageInfo!

Information to aid in pagination.

totalCountInt!

The total number of elements.

VariantPriceEdge#

FieldArgumentTypeDescription
cursorString!

A marker for an edge's position in the connection

nodeVariantPrice!

An object with an ID to support global identification.

VariantPricePageInfo#

FieldArgumentTypeDescription
startCursorString

A start cursor for use in pagination.

endCursorString

An end cursor for use in pagination.

hasPreviousPageBoolean

Whether the result has a previous page.

hasNextPageBoolean

Whether the result has a next page.

VariantStock#

variantStocks - Represents information about the stock of a variant.

FieldArgumentTypeDescription
rawQuantityInt

The variant stock unformatted quantity.

formattedQuantityString

The variant stock formatted quantity.

rawValuationFloat

The variant stock unformatted valuation.

formattedValuationString

The variant stock formatted valuation.

stateVariantStockState

The variant stock state.