Inputs

The root Input type in a GraphQL schema defines all the input entries of a query or mutation.

Queries Inputs

StringEqualsFilter

Field		Type	Description
_equals		String!	Should equals the specified string.

BooleanEqualsFilter

Field		Type	Description
_equals		Boolean!	Should equals the specified string.

DateFilter

Field		Type	Description
_after		Datetime	Should be after the specified date.
_before		Datetime	Should be before the specified date.
_between		[Datetime!]	Should be between the two specified dates.

InFilter

Field		Type	Description
_in		[String!]!	Should contains the specified list of elements.

InputPricesQueryFilter

Field		Type	Description
shopIds		InFilter	Returns only the prices related to the selected shops.
archived		ArchivedFilter	Returns all suppliers with the status specified.

InputProductVariantsQueryFilter

Field		Type	Description
archived		ArchivedFilter	Returns all variants with the status specified.

InputVariantsOrderBy

Field		Type	Description
createdAt		OrderBy	The variant creation date.
active		OrderBy	The variant active status.

InputVariantsQueryFilter

Field		Type	Description
shopIds		InFilter	Returns only the variants related to the selected shops.
stockKeepingUnit		StringEqualsFilter	Returns only the variants with the stockKeepingUnit specified.
active		BooleanEqualsFilter	Returns only the variants with the active specified.
archived		ArchivedFilter	Returns all suppliers with the status specified.
categoryId		StringEqualsFilter	Returns only the variants related to products related to the category specified.
createdAt		DateFilter	Returns all variants with the creation date specified.

ProductColorEqualsFilter

Field		Type	Description
_equals		ProductColor!	Should equals the specified product color.

ProductKindEqualsFilter

Field		Type	Description
_equals		ProductKind!	Should equals the specified product kind.

InputProductsQueryFilter

Field		Type	Description
name		StringEqualsFilter	Returns only the products with the specified name.
kind		ProductKindEqualsFilter	Returns only the products with the specified kind.
producer		StringEqualsFilter	Returns only the products with the specified producer.
color		ProductColorEqualsFilter	Returns only the products with the specified color.
variantCkus		InFilter	Returns only the products related to the selected variant ckus.
shopIds		InFilter	Returns only the products related to the selected shops.
archived		ArchivedFilter	Returns all products with the status specified.

InputStockActivitiesQueryFilter

Field		Type	Description
kind		InFilter	Returns all stock activities with the kind specified.
reason		InFilter	Returns all stock activities with the reason specified.
date		DateFilter	Returns all stock activities with the date specified.
shopIds		InFilter	Returns only the stock activities related to the selected shops.

InputTaxQueryFilter

Field		Type	Description
shopIds		InFilter	Returns only the taxes related to the selected shops.

### InputUpdatePrice

Field		Type	Description
name		String!
taxIncluded		Boolean!
enableByDefault		Boolean!

InputVariantStockActivitiesQueryFilter

Field		Type	Description
kind		InFilter	Returns all stock activities with the kind specified.
reason		InFilter	Returns all stock activities with the reason specified.
date		DateFilter	Returns all stock activities with the date specified.
shopIds		InFilter	Returns only the stock activities related to the selected shops.

InputCategoriesQueryFilter

Field		Type	Description
archived		ArchivedFilter	Returns all categories with the status specified.
hasChildren		Boolean	Returns all categories with/without children.
name		StringEqualsFilter	Returns all categories with the specified name
parentName		StringEqualsFilter	Returns all categories with the specified category parent name
shopIds		InFilter	Returns only the categories related to the selected shops.

Mutations Inputs

InputCreatePrice

Field		Type	Description
name		String!
taxIncluded		Boolean!
enableByDefault		Boolean!
shopId		String!	The shop associated to this price.

InputCreateProduct

Field		Type	Description
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.
taxId		String!	A tax assigned to the product.
categoryId		String	A category assigned to the product.
shopId		String!	The shop associated with this product.

InputCreateStockActivity

Field		Type	Description
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		String	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.
variantId		String!	The variant reference.
deviceId		String!	The device associated to this stock activity.
shopId		String!	The shop associated to this stock activity.

InputCreateVariant

Field		Type	Description
stockKeepingUnit		String	A unique identifier assigned to each variant.
name		String!	The variant name.
purchasedPrice		Float	The variant purchased price.
year		Int	The variant year.
capacityValue		Float	The variant capacity
capacityUnit		String	The variant capacity unit.
capacityPrecision		Int	The variant capacity precision.
alcoholVolume		Float	The variant alcohol volume.
ean13		String	The variant European Article Number
bulk		Boolean	Specifies if this variant is sold in bulk or not.
packaging		Int	The variant packaging number.
internalCode		String	An internal code of the variant.
accountingCode		String	An internal code to categorize the variants in an accounting way.
minStockThreshold		Int	The variant minimum recommended stock value.
maxStockThreshold		Int	The variant maximum recommended stock value.
stockOrderTriggerThreshold		Int	Variant stock threshold at which an order should be created to add more stock supply.
productId		String!	The product assigned to the variant.
supplierId		String	The supplier assigned to the variant.
shopId		String!	The shop associated with this variant.

InputCreateVariantPrices

Field		Type	Description
valueIncludingTax		Float!
valueExcludingTax		Float!
fromQuantity		Float
toQuantity		Float
priceId		String!

InputUpdateProduct

Field		Type	Description
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.
taxId		String	A tax assigned to the product.
categoryId		String	A category assigned to the product.
metadata		InputUpdateProductMetaData

InputUpdateProductCategory

Field		Type	Description
categoryId		String	A category assigned to the product.

InputUpdateProductMetaData

Field		Type	Description
shopifyProductId		String	A shopify ID related to the product.

InputUpdateVariant

Field		Type	Description
stockKeepingUnit		String	A unique identifier assigned to each variant.
name		String	The variant name.
purchasedPrice		Float	The variant purchased price.
year		Int	The variant year.
capacityValue		Float	The variant capacity
capacityUnit		String	The variant capacity unit.
capacityPrecision		Int	The variant capacity precision.
alcoholVolume		Float	The variant alcohol volume.
ean13		String	The variant European Article Number
internalNote		Text	An internal note about the variant.
metadata		InputUpdateVariantMetaData
tastingNote		Text	A note about the variant taste.
packaging		Int	The variant packaging number.
internalCode		String	An internal code of the variant.
accountingCode		String	An internal code to categorize the variants in an accounting way.
supplierId		String	The supplier assigned to the variant.
minStockThreshold		Int	The variant minimum recommended stock value.
maxStockThreshold		Int	The variant maximum recommended stock value.
stockOrderTriggerThreshold		Int	Variant stock threshold at which an order should be created to add more stock supply.

InputUpdateVariantMetaData

Field		Type	Description
shopifyVariantId		String	A shopify ID related to the variant.

InputUpdateVariantPrices

Field		Type	Description
id		ID
valueIncludingTax		Float!
valueExcludingTax		Float!
fromQuantity		Float
toQuantity		Float
priceId		String!