Skip to main content

Inputs

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

Mutation Inputs#

InputCreatePrice#

FieldTypeDescription
nameString!
taxIncludedBoolean!
enableByDefaultBoolean!
shopIdString!

The shop associated to this price.

InputCreateProduct#

FieldTypeDescription
nameString!

The product name.

designationString

The product designation.

colorProductColor

The product 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.

internalNoteText

An internal note about the product.

taxIdString!

A tax assigned to the product.

categoryIdString

A category assigned to the product.

shopIdString!

The shop associated with this product.

InputCreateStockActivity#

FieldTypeDescription
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.

capacityPrecisionInt

The decimal accuracy of stock activity capacity.

variantIdString!

The variant reference.

deviceIdString!

The device associated to this stock activity.

shopIdString!

The shop associated to this stock activity.

InputCreateVariant#

FieldTypeDescription
stockKeepingUnitString

A unique identifier assigned to each variant.

nameString!

The variant name.

purchasedPriceFloat

The variant purchased price.

yearInt

The variant year.

capacityValueFloat

The variant capacity

capacityUnitString

The variant capacity unit.

capacityPrecisionInt

The variant capacity precision.

alcoholVolumeFloat

The variant alcohol volume.

ean13String

The variant European Article Number

bulkBoolean

Specifies if this variant is sold in bulk or not.

packagingInt

The variant packaging number.

internalCodeString

An internal code of the variant.

productIdString!

The product assigned to the variant.

shopIdString!

The shop associated with this variant.

InputCreateVariantPrices#

FieldTypeDescription
valueIncludingTaxFloat!
valueExcludingTaxFloat!
fromQuantityFloat
toQuantityFloat
priceIdString!

InputUpdatePrice#

FieldTypeDescription
nameString!
taxIncludedBoolean!
enableByDefaultBoolean!

InputUpdateProduct#

FieldTypeDescription
nameString

The product name.

designationString

The product designation.

colorProductColor

The product 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.

internalNoteText

An internal note about the product.

taxIdString

A tax assigned to the product.

categoryIdString

A category assigned to the product.

InputUpdateVariant#

FieldTypeDescription
stockKeepingUnitString

A unique identifier assigned to each variant.

nameString

The variant name.

purchasedPriceFloat

The variant purchased price.

yearInt

The variant year.

capacityValueFloat

The variant capacity

capacityUnitString

The variant capacity unit.

capacityPrecisionInt

The variant capacity precision.

alcoholVolumeFloat

The variant alcohol volume.

ean13String

The variant European Article Number

internalNoteText

An internal note about the variant.

tastingNoteText

A note about the variant taste.

packagingInt

The variant packaging number.

internalCodeString

An internal code of the variant.

InputUpdateVariantPrices#

FieldTypeDescription
idID
valueIncludingTaxFloat!
valueExcludingTaxFloat!
fromQuantityFloat
toQuantityFloat
priceIdString!

InputVariantsOrderBy#

FieldTypeDescription
createdAtOrderBy

The variant creation date.

activeOrderBy

The variant active status.

Query Inputs#

BooleanEqualsFilter#

FieldTypeDescription
_equalsBoolean!

Should equals the specified string.

DateFilter#

FieldTypeDescription
_afterDatetime

Should be after the specified date.

_beforeDatetime

Should be before the specified date.

_between[Datetime!]

Should be between the two specified dates.

InFilter#

FieldTypeDescription
_in[String!]!

Should contains the specified list of elements.

StringEqualsFilter#

FieldTypeDescription
_equalsString!

Should equals the specified string.

InputDevicesQueryFilter#

FieldTypeDescription
slugStringEqualsFilter

Returns all devices with the specified slug.

nameStringEqualsFilter

Returns all devices with the specified name.

InputProductVariantsQueryFilter#

FieldTypeDescription
archivedArchivedFilter

Returns all variants with the status specified.

InputStockActivitiesQueryFilter#

FieldTypeDescription
kindInFilter

Returns all stock activities with the kind specified.

reasonInFilter

Returns all stock activities with the reason specified.

dateDateFilter

Returns all stock activities with the date specified.

shopIdsInFilter

Returns only the stock activities related to the selected shops.

InputVariantStockActivitiesQueryFilter#

FieldTypeDescription
kindInFilter

Returns all stock activities with the kind specified.

reasonInFilter

Returns all stock activities with the reason specified.

dateDateFilter

Returns all stock activities with the date specified.

shopIdsInFilter

Returns only the stock activities related to the selected shops.

InputVariantsQueryFilter#

FieldTypeDescription
shopIdsInFilter

Returns only the variants related to the selected shops.

activeBooleanEqualsFilter

Returns only the variants with the active specified.

stockKeepingUnitStringEqualsFilter

Returns only the variants with the stockKeepingUnit specified.

archivedArchivedFilter

Returns all suppliers with the status specified.