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.

Field	Argument	Type	Description
id	ID!	Specifies the category to update, or creates a new category if one doesn't exist.
archivedAt	Datetime	The date and time when the category was archived.
updatedAt	Datetime!	The date and time when the category was last updated.
createdAt	Datetime!	The date and time when the category was added to the store.
name	String!	The category name.
formattedName	String!	The combination of the name of the parent category with the name of this category.
color	String!	The category color.
locked	Boolean!	Specifies if this category can be edited (name and color).
parent	Category	The parent category of this category.
shop	Shop!	The shop associated to this category.

Field	Argument	Type	Description
edges	[CategoryEdge!]!	A list of edges.
pageInfo	CategoryPageInfo!	Information to aid in pagination.
totalCount	Int!	The total number of elements.

Field	Argument	Type	Description
cursor	String!	A marker for an edge's position in the connection
node	Category!	An object with an ID to support global identification.

Field	Argument	Type	Description
startCursor	String	A start cursor for use in pagination.
endCursor	String	An end cursor for use in pagination.
hasPreviousPage	Boolean	Whether the result has a previous page.
hasNextPage	Boolean	Whether the result has a next page.

Device

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

Field	Type	Description
id	ID!	Specifies the device to update, or creates a new device if one doesn't exist.
archivedAt	Datetime	The date and time when the device was archived.
updatedAt	Datetime!	The date and time when the device was last updated.
createdAt	Datetime!	The date and time when the device was added to the store.
name	String!	The device name.
slug	String!	The device slug.
uid	String!	The device unique identifier.
locale	String	The device specific region.
userAgent	String	The device user agent identification.
brand	String	The device brand.
model	String	The device model.
systemVersion	String	The device system version.
shop	Shop!	The shop associated with this device.

DeviceConnection

Field	Type	Description
edges	[DeviceEdge!]!	A list of edges.
pageInfo	DevicePageInfo!	Information to aid in pagination.
totalCount	Int!	The total number of elements.

DeviceEdge

Field	Argument	Type	Description
cursor		String!	A marker for an edge's position in the connection
node		Device!	An object with an ID to support global identification.

DevicePageInfo

Field	Type	Description
startCursor	String	A start cursor for use in pagination.
endCursor	String	An end cursor for use in pagination.
hasPreviousPage	Boolean	Whether the result has a previous page.
hasNextPage	Boolean	Whether the result has a next page.

Price

Represents the price lists proposed by the store.

Field	Type	Description
id	ID!	Specifies the price to update, or creates a new price if one doesn't exist.
archivedAt	Datetime	The date and time when the price was archived.
updatedAt	Datetime!	The date and time when the price was last updated.
createdAt	Datetime!	The date and time when the price was added to the store.
name	String!	The price name.
enableByDefault	Boolean!	Specifies if this price will be enabled by default.
taxIncluded	Boolean!	Specifies if this price will include taxes.
shop	Shop!	The shop associated with this price.

PriceConnection

Field	Type	Description
edges	[PriceEdge!]!	A list of edges.
pageInfo	PricePageInfo!	Information to aid in pagination.
totalCount	Int!	The total number of elements.

PriceEdge

Field	Argument	Type	Description
cursor		String!	A marker for an edge's position in the connection
node		Price!	An object with an ID to support global identification.

PricePageInfo

Field	Type	Description
startCursor	String	A start cursor for use in pagination.
endCursor	String	An end cursor for use in pagination.
hasPreviousPage	Boolean	Whether the result has a previous page.
hasNextPage	Boolean	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.

Field	Type	Description
id	ID!	Specifies the product to update, or creates a new product if one doesn't exist.
archivedAt	Datetime	The date and time when the product was archived.
updatedAt	Datetime!	The date and time when the product was last updated.
createdAt	Datetime!	The date and time when the product was added to the store.
name	String!	The product name.
designation	String	The product designation.
color	ProductColor	The product color.
kind	ProductKind!	The product kind. It is defined as one of the following options: spirituous, wine, beer or simple.
family	String	The product family.
producer	String	The product producer.
country	String	The country where the product comes from.
region	String	The region where the product comes from.
beerType	String	The beer type when the product has the kind property equal to beer.
wineType	ProductWineType	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.
whiteWineType	ProductWhiteWineType	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.
internalNote	Text	An internal note about the product.
formattedDescription	String	A formatted description of the product.
formattedOrigin	String!	A formatted origin of the product.
formattedStatus	ProductStatus	The status of the product.
tax	Tax	A tax assigned to the product.
category	Category	A category assigned to the product.
variants	VariantConnection!	A list of variants assigned to the product.
first	Int	Returns up to the first n elements from the list.
last	Int	Returns up to the last n elements from the list.
before	String	Returns the elements that come before the specified cursor.
after	String	Returns the elements that come after the specified cursor.
filterBy	InputProductVariantsQueryFilter
shop	Shop!	The shop associated with this product.

ProductConnection

Field	Type	Description
edges	[ProductEdge!]!	A list of edges.
pageInfo	ProductPageInfo!	Information to aid in pagination.
totalCount	Int!	The total number of elements.

ProductEdge

Field	Argument	Type	Description
cursor		String!	A marker for an edge's position in the connection
node		Product!	An object with an ID to support global identification.

ProductPageInfo

Field	Type	Description
startCursor	String	A start cursor for use in pagination.
endCursor	String	An end cursor for use in pagination.
hasPreviousPage	Boolean	Whether the result has a previous page.
hasNextPage	Boolean	Whether the result has a next page.

Shop

Represents information about the shop.

Field	Type	Description
id	ID!	Specifies the Shop to update, or creates a new Shop if one doesn't exist.
archivedAt	Datetime	The date and time when the Shop was archived.
updatedAt	Datetime!	The date and time when the Shop was last updated.
createdAt	Datetime!	The date and time when the Shop was added to the store.
name	String!	The shop name.
logo ⚠️	String	The shop logo. ⚠️ DEPRECATED This attribute has been replaced by logoUri.
address	String!	The shop address.
postalCode	String!	The shop postal code.
city	String!	The shop city.
cityOfRegistryOffice	String	The shop city.
country	String!	The shop country.
phoneNumber	String	The shop phone number.
email	String	The shop email.
website	String	The shop website.
fiscalYearEndClosingMonth	String	Represents to the completion of a one-year, or 12-month, accounting period.
corporateName	String	The shop corporate name.
legalRepresentative	String	The shop legal representative.
legalForm	String	The legal type of the shop (e.g: SAS, SARL ...).
amountOfShareCapital	String	The amount of share capital of the shop.
tvaNumber	String	The shop TVA number.
siretNumber	String	The shop SIRET number.
rcsNumber	String	The shop RCS number.
apeNafCode	String	The shop code APE / NAF.
bankName	String	The shop bank name.
bankCode	String	The shop bank code.
bankAccountHolder	String	The bank account holder of the shop.
bankAccountNumber	String	The bank account number of the shop.
bicCode	String	The BIC Code of the shop.
ibanNumber	String	The IBAN number of the shop.
logoUri	String	The uri of the shop logo.
settings	JSON!	Set of constants defined by the shop.

ShopConnection

Field	Type	Description
edges	[ShopEdge!]!	A list of edges.
pageInfo	ShopPageInfo!	Information to aid in pagination.
totalCount	Int!	The total number of elements.

ShopEdge

Field	Argument	Type	Description
cursor		String!	A marker for an edge's position in the connection
node		Shop!	An object with an ID to support global identification.

ShopPageInfo

Field	Type	Description
startCursor	String	A start cursor for use in pagination.
endCursor	String	An end cursor for use in pagination.
hasPreviousPage	Boolean	Whether the result has a previous page.
hasNextPage	Boolean	Whether the result has a next page.

StockActivity

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

Field	Type	Description
id	ID!	Specifies the stockActivity to update, or creates a new stockActivity if one doesn't exist.
archivedAt	Datetime	The date and time when the stock activity was archived.
updatedAt	Datetime!	The date and time when the stock activity was last updated.
createdAt	Datetime!	The date and time when the stock activity was added to the store.
formattedLabel	String!	The stock activity formatted label.
formattedQuantity	String!	The stock activity formatted quantity.
kind	StockActivityKind!	The type of this stock activity. Some types can increment the stock, others can decrement it or reset it.
quantity	Int!	The quantity associated to this stock activity.
comment	Text	A comment about this stock activity.
reason	StockActivityLossReason	Represents the possible reasons why the `stockActivity` was classified as a `LOSS`.
stockKeepingUnit	String	A unique identifier assigned to each activity.
capacityUnit	String	The unit used in this stock activity.
capacityPrecision	Int	The decimal accuracy of stock activity capacity.
variant	Variant	The variant reference.
device	Device!	The device associated to this stock activity.
shop	Shop!	The shop associated to this stock activity.

StockActivityConnection

Field	Type	Description
edges	[StockActivityEdge!]!	A list of edges.
pageInfo	StockActivityPageInfo!	Information to aid in pagination.
totalCount	Int!	The total number of elements.

StockActivityEdge

Field	Argument	Type	Description
cursor		String!	A marker for an edge's position in the connection
node		StockActivity!	An object with an ID to support global identification.

StockActivityPageInfo

Field	Type	Description
startCursor	String	A start cursor for use in pagination.
endCursor	String	An end cursor for use in pagination.
hasPreviousPage	Boolean	Whether the result has a previous page.
hasNextPage	Boolean	Whether the result has a next page.

Tax

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

Field	Type	Description
id	ID!	Specifies the tax to update, or creates a new tax if one doesn't exist.
archivedAt	Datetime	The date and time when the tax was archived.
updatedAt	Datetime!	The date and time when the tax was last updated.
createdAt	Datetime!	The date and time when the tax was added to the store.
name	String!	The tax name.
value	Float!	The tax value.
shop	Shop!	The shop associated to this tax.

TaxConnection

Field	Type	Description
edges	[TaxEdge!]!	A list of edges.
pageInfo	TaxPageInfo!	Information to aid in pagination.
totalCount	Int!	The total number of elements.

TaxEdge

Field	Argument	Type	Description
cursor		String!	A marker for an edge's position in the connection
node		Tax!	An object with an ID to support global identification.

TaxPageInfo

Field	Type	Description
startCursor	String	A start cursor for use in pagination.
endCursor	String	An end cursor for use in pagination.
hasPreviousPage	Boolean	Whether the result has a previous page.
hasNextPage	Boolean	Whether the result has a next page.

Variant

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

Field	Type	Description
id	ID!	Specifies the variant to update, or creates a new variant if one doesn't exist.
archivedAt	Datetime	The date and time when the variant was archived.
updatedAt	Datetime!	The date and time when the variant was last updated.
createdAt	Datetime!	The date and time when the variant was added to the store.
stockKeepingUnit	String	A unique identifier assigned to each variant.
name	String!	The variant name.
active	Boolean	Specifies if this variant is active for sale or not.
formattedName	String!	The combination of the name of the parent product and the name of the variant child.
formattedDescription	String!	The combination of the name, color, producer, region and country of the parent product.
formattedStatus	VariantStatus!	The status of the variant.
purchasedPrice	Float	The variant purchased price.
formattedPurchasedPrice	String	The variant formatted purchased price.
formattedCategory	String	The variant formatted category.
year	Int	The variant year.
capacity ⚠️	Float	The variant capacity. ⚠️ DEPRECATED This attribute has been replaced by capacityValue.
capacityValue	Float	The variant capacity
capacityUnit	String	The variant capacity unit.
capacityPrecision	Int	The variant capacity precision.
alcoholVolume	Float	The variant alcohol volume.
stock	VariantStock!	The variant stock.
ean13	String	The variant European Article Number
bulk	Boolean	Specifies if this variant is sold in bulk or not.
internalNote	Text	An internal note about the variant.
tastingNote	Text	A note about the variant taste.
packaging	Int	The variant packaging number.
internalCode	String	An internal code of the variant.
product	Product	A product assigned to the variant.
stockActivities	StockActivityConnection!	A list of stock activities assigned to the variant.
first	Int	Returns up to the first n elements from the list.
last	Int	Returns up to the last n elements from the list.
before	String	Returns the elements that come before the specified cursor.
after	String	Returns the elements that come after the specified cursor.
search	String
filterBy	InputVariantStockActivitiesQueryFilter
variantPrices	VariantPriceConnection!	A list of prices assigned to the variant.
first	Int	Returns up to the first n elements from the list.
last	Int	Returns up to the last n elements from the list.
before	String	Returns the elements that come before the specified cursor.
after	String	Returns the elements that come after the specified cursor.
orderProducts	OrderProductConnection!	A list of order products assigned to the variant.
first	Int	Returns up to the first n elements from the list.
last	Int	Returns up to the last n elements from the list.
before	String	Returns the elements that come before the specified cursor.
after	String	Returns the elements that come after the specified cursor.
search	String
filterBy	InputVariantOrderProductsQueryFilter
shop	Shop!	The shop associated with this variant.

VariantConnection

Field	Type	Description
edges	[VariantEdge!]!	A list of edges.
pageInfo	VariantPageInfo!	Information to aid in pagination.
totalCount	Int!	The total number of elements.

VariantEdge

Field	Argument	Type	Description
cursor		String!	A marker for an edge's position in the connection
node		Variant!	An object with an ID to support global identification.

VariantPageInfo

Field	Type	Description
startCursor	String	A start cursor for use in pagination.
endCursor	String	An end cursor for use in pagination.
hasPreviousPage	Boolean	Whether the result has a previous page.
hasNextPage	Boolean	Whether the result has a next page.

VariantPrice

Represents the selling price list of product variants.

Field	Type	Description
id	ID!	Specifies the instance of VariantPrice to update, or creates a new instance of VariantPrice if one doesn't exist.
archivedAt	Datetime	The date and time when the instance of VariantPrice was archived.
updatedAt	Datetime!	The date and time when the instance of VariantPrice was last updated.
createdAt	Datetime!	The date and time when the instance of VariantPrice was added to the store.
valueIncludingTax	Float!	The variant price value including tax.
valueExcludingTax	Float!	The variant price value excluding tax.
fromQuantity	Float	The minimum quantity for this variant price.
toQuantity	Float	The maximum quantity for this variant price.
price	Price	The price reference.
variant	Variant	The variant reference.
shop	Shop!	The shop associated with this variant price.

VariantPriceConnection

Field	Type	Description
edges	[VariantPriceEdge!]!	A list of edges.
pageInfo	VariantPricePageInfo!	Information to aid in pagination.
totalCount	Int!	The total number of elements.

VariantPriceEdge

Field	Argument	Type	Description
cursor		String!	A marker for an edge's position in the connection
node		VariantPrice!	An object with an ID to support global identification.

VariantPricePageInfo

Field	Type	Description
startCursor	String	A start cursor for use in pagination.
endCursor	String	An end cursor for use in pagination.
hasPreviousPage	Boolean	Whether the result has a previous page.
hasNextPage	Boolean	Whether the result has a next page.

VariantStock

Represents information about the stock of a variant.

Field	Type	Description
rawQuantity	Int	The variant stock unformatted quantity.
formattedQuantity	String	The variant stock formatted quantity.
rawValuation	Float	The variant stock unformatted valuation.
formattedValuation	String	The variant stock formatted valuation.
state	VariantStockState	The variant stock state.

Category​

CategoryConnection​

CategoryEdge​

CategoryPageInfo​

Device​

DeviceConnection​

DeviceEdge​

DevicePageInfo​

Price​

PriceConnection​

PriceEdge​

PricePageInfo​

Product​

ProductConnection​

ProductEdge​

ProductPageInfo​

Shop​

ShopConnection​

ShopEdge​

ShopPageInfo​

StockActivity​

StockActivityConnection​

StockActivityEdge​

StockActivityPageInfo​

Tax​

TaxConnection​

TaxEdge​

TaxPageInfo​

Variant​

VariantConnection​

VariantEdge​

VariantPageInfo​

VariantPrice​

VariantPriceConnection​

VariantPriceEdge​

VariantPricePageInfo​

VariantStock​

Category

CategoryConnection

CategoryEdge

CategoryPageInfo