Skip to main content

Inputs

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

Queries Inputs

StringEqualsFilter

FieldTypeDescription
_equalsString!

Should equals the specified string.

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.

InputPricesQueryFilter

FieldTypeDescription
shopIdsInFilter

Returns only the prices related to the selected shops.

archivedArchivedFilter

Returns all suppliers with the status specified.

InputProductVariantsQueryFilter

FieldTypeDescription
archivedArchivedFilter

Returns all variants with the status specified.

InputVariantsOrderBy

FieldTypeDescription
createdAtOrderBy

The variant creation date.

activeOrderBy

The variant active status.

InputVariantsQueryFilter

FieldTypeDescription
shopIdsInFilter

Returns only the variants related to the selected shops.

stockKeepingUnitStringEqualsFilter

Returns only the variants with the stockKeepingUnit specified.

activeBooleanEqualsFilter

Returns only the variants with the active specified.

archivedArchivedFilter

Returns all suppliers with the status specified.

categoryIdStringEqualsFilter

Returns only the variants related to products related to the category specified.

createdAtDateFilter

Returns all variants with the creation date specified.

ProductColorEqualsFilter

FieldTypeDescription
_equalsProductColor!

Should equals the specified product color.

ProductKindEqualsFilter

FieldTypeDescription
_equalsProductKind!

Should equals the specified product kind.

InputProductsQueryFilter

FieldTypeDescription
nameStringEqualsFilter

Returns only the products with the specified name.

kindProductKindEqualsFilter

Returns only the products with the specified kind.

producerStringEqualsFilter

Returns only the products with the specified producer.

colorProductColorEqualsFilter

Returns only the products with the specified color.

variantCkusInFilter

Returns only the products related to the selected variant ckus.

shopIdsInFilter

Returns only the products related to the selected shops.

archivedArchivedFilter

Returns all products 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.

InputTaxQueryFilter

FieldTypeDescription
shopIdsInFilter

Returns only the taxes related to the selected shops.

### InputUpdatePrice
FieldTypeDescription
nameString!
taxIncludedBoolean!
enableByDefaultBoolean!

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.

InputCategoriesQueryFilter

FieldTypeDescription
archivedArchivedFilter

Returns all categories with the status specified.

hasChildrenBoolean

Returns all categories with/without children.

nameStringEqualsFilter

Returns all categories with the specified name

parentNameStringEqualsFilter

Returns all categories with the specified category parent name

shopIdsInFilter

Returns only the categories related to the selected shops.

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

accountingCodeString

An internal code to categorize the variants in an accounting way.

minStockThresholdInt

The variant minimum recommended stock value.

maxStockThresholdInt

The variant maximum recommended stock value.

stockOrderTriggerThresholdInt

Variant stock threshold at which an order should be created to add more stock supply.

productIdString!

The product assigned to the variant.

supplierIdString

The supplier assigned to the variant.

shopIdString!

The shop associated with this variant.

InputCreateVariantPrices

FieldTypeDescription
valueIncludingTaxFloat!
valueExcludingTaxFloat!
fromQuantityFloat
toQuantityFloat
priceIdString!

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.

metadataInputUpdateProductMetaData

InputUpdateProductCategory

FieldTypeDescription
categoryIdString

A category assigned to the product.

InputUpdateProductMetaData

FieldTypeDescription
shopifyProductIdString

A shopify ID related 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.

metadataInputUpdateVariantMetaData
tastingNoteText

A note about the variant taste.

packagingInt

The variant packaging number.

internalCodeString

An internal code of the variant.

accountingCodeString

An internal code to categorize the variants in an accounting way.

supplierIdString

The supplier assigned to the variant.

minStockThresholdInt

The variant minimum recommended stock value.

maxStockThresholdInt

The variant maximum recommended stock value.

stockOrderTriggerThresholdInt

Variant stock threshold at which an order should be created to add more stock supply.

InputUpdateVariantMetaData

FieldTypeDescription
shopifyVariantIdString

A shopify ID related to the variant.

InputUpdateVariantPrices

FieldTypeDescription
idID
valueIncludingTaxFloat!
valueExcludingTaxFloat!
fromQuantityFloat
toQuantityFloat
priceIdString!