Documentation
All the Flavors.com GraphQL API
Terms of Service
API Endpoints
http://localhost:3939/apiVersion
2.1.0
Queries
badge
Description
Get a Badge
Example
Query
query badge($id: Int) {
badge(id: $id) {
id
createdAt
updatedAt
name
image
description
itemTypeId
supersedes
icon
ItemType {
...ItemTypeFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"badge": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"image": "abc123",
"description": "abc123",
"itemTypeId": 987,
"supersedes": 123,
"icon": "abc123",
"ItemType": ItemType
}
}
}
badges
Description
Get Badges
Response
Returns a BadgeNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
Maximum Number of Rows to Return |
offset - Int
|
Number of Rows to Skip |
filter - BadgeFilter
|
Badge Filters |
sort - Sort
|
Badge Sorting |
Example
Query
query badges(
$limit: Int,
$offset: Int,
$filter: BadgeFilter,
$sort: Sort
) {
badges(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
totalCount
count
nodes {
...BadgeFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"filter": BadgeFilter,
"sort": Sort
}
Response
{
"data": {
"badges": {
"totalCount": 123,
"count": 123,
"nodes": [Badge]
}
}
}
badgesList
Description
Get Badges List
Response
Returns [Badge]
Arguments
| Name | Description |
|---|---|
filter - BadgeFilter
|
Badge Filters |
sort - Sort
|
Badge Sorting |
Example
Query
query badgesList(
$filter: BadgeFilter,
$sort: Sort
) {
badgesList(
filter: $filter,
sort: $sort
) {
id
createdAt
updatedAt
name
image
description
itemTypeId
supersedes
icon
ItemType {
...ItemTypeFragment
}
}
}
Variables
{
"filter": BadgeFilter,
"sort": Sort
}
Response
{
"data": {
"badgesList": [
{
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"image": "abc123",
"description": "abc123",
"itemTypeId": 123,
"supersedes": 123,
"icon": "xyz789",
"ItemType": ItemType
}
]
}
}
batch
Example
Query
query batch(
$id: Int,
$lot: String
) {
batch(
id: $id,
lot: $lot
) {
id
userId
recipeId
formulationId
createdAt
updatedAt
name
cost
batchSize
amountRemaining
version
lot
notes
data
desiredMixingPercent
isForSale
wasSold
Formulation {
...FormulationFragment
}
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 987, "lot": "xyz789"}
Response
{
"data": {
"batch": {
"id": 987,
"userId": 987,
"recipeId": 123,
"formulationId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"cost": 123.45,
"batchSize": 123.45,
"amountRemaining": 987.65,
"version": "xyz789",
"lot": "xyz789",
"notes": {},
"data": {},
"desiredMixingPercent": 123.45,
"isForSale": true,
"wasSold": true,
"Formulation": Formulation,
"Recipe": SimpleRecipe,
"User": User
}
}
}
batchRequest
Response
Returns a BatchRequest
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query batchRequest($id: Int) {
batchRequest(id: $id) {
id
userId
recipeId
createdAt
updatedAt
batchLot
amountRequested
isActive
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
Batch {
...SaleBatchFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"batchRequest": {
"id": 987,
"userId": 123,
"recipeId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"batchLot": "abc123",
"amountRequested": 123.45,
"isActive": true,
"Recipe": SimpleRecipe,
"User": User,
"Batch": SaleBatch
}
}
}
batchRequests
Response
Returns a BatchRequestNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - BatchRequestFilter
|
|
sort - SortMultiple
|
Example
Query
query batchRequests(
$limit: Int,
$offset: Int,
$filter: BatchRequestFilter,
$sort: SortMultiple
) {
batchRequests(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
totalCount
count
nodes {
...BatchRequestFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"filter": BatchRequestFilter,
"sort": SortMultiple
}
Response
{
"data": {
"batchRequests": {
"totalCount": 123,
"count": 123,
"nodes": [BatchRequest]
}
}
}
batches
Response
Returns a BatchNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - BatchFilter
|
|
sort - SortMultiple
|
Example
Query
query batches(
$limit: Int,
$offset: Int,
$filter: BatchFilter,
$sort: SortMultiple
) {
batches(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
totalCount
count
nodes {
...BatchFragment
}
}
}
Variables
{
"limit": 123,
"offset": 123,
"filter": BatchFilter,
"sort": SortMultiple
}
Response
{
"data": {
"batches": {
"totalCount": 987,
"count": 123,
"nodes": [Batch]
}
}
}
countries
Description
Get Countries
Response
Returns [Country]
Example
Query
query countries {
countries {
id
name
iso2
iso3
}
}
Response
{
"data": {
"countries": [
{
"id": 123,
"name": "xyz789",
"iso2": "xyz789",
"iso3": "xyz789"
}
]
}
}
currentUser
Description
Get Current User
Response
Returns a CurrentUser
Example
Query
query currentUser {
currentUser {
id
username
createdAt
updatedAt
email
banned
bannedAt
bannedEnd
bannedReason
bannedByUserId
confirmedAt
currentLoginDate
logins
prevLoginDate
resetAt
image
description
favorites
recipes
rating
ratings
publicRecipes
flavors
interests
location
restricted
settings
imageThumb
imageUrl
loggedIn
abilities
Session {
...SessionFragment
}
}
}
Response
{
"data": {
"currentUser": {
"id": 987,
"username": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "abc123",
"banned": false,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "xyz789",
"bannedByUserId": 123,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 987,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z",
"image": "xyz789",
"description": "abc123",
"favorites": 123,
"recipes": 987,
"rating": 123.45,
"ratings": 987,
"publicRecipes": 987,
"flavors": 987,
"interests": "xyz789",
"location": 987,
"restricted": false,
"settings": {},
"imageThumb": "abc123",
"imageUrl": "abc123",
"loggedIn": true,
"abilities": {},
"Session": [Session]
}
}
}
flavor
Example
Query
query flavor(
$id: Int,
$slug: String
) {
flavor(
id: $id,
slug: $slug
) {
id
vendorId
density
createdAt
updatedAt
name
slug
rating
ratings
url
views
favorites
averageMillipercent
baseId
recipes
recMinMillipercent
recMaxMillipercent
vendorMillipercent
vendorUrl
discontinued
isFavorite
isStashed
FlavorStash {
...FlavorStashFragment
}
stashes
Vendor {
...VendorFragment
}
FlavorBase {
...IngredientFragment
}
RetailFlavor {
...RetailFlavorFragment
}
Sellers {
...RetailFlavorFragment
}
vendorPercent
flavorUsage
FlavorTag {
...FlavorTagFragment
}
}
}
Variables
{"id": 987, "slug": "abc123"}
Response
{
"data": {
"flavor": {
"id": 987,
"vendorId": 987,
"density": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"slug": "xyz789",
"rating": 987.65,
"ratings": 123,
"url": "abc123",
"views": 123,
"favorites": 987,
"averageMillipercent": 987,
"baseId": 123,
"recipes": 123,
"recMinMillipercent": 123,
"recMaxMillipercent": 987,
"vendorMillipercent": 987,
"vendorUrl": "abc123",
"discontinued": true,
"isFavorite": false,
"isStashed": false,
"FlavorStash": FlavorStash,
"stashes": 987,
"Vendor": Vendor,
"FlavorBase": Ingredient,
"RetailFlavor": RetailFlavor,
"Sellers": [RetailFlavor],
"vendorPercent": 987.65,
"flavorUsage": {},
"FlavorTag": [FlavorTag]
}
}
}
flavorList
Response
Returns a FlavorList
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query flavorList($id: Int) {
flavorList(id: $id) {
id
userId
createdAt
updatedAt
name
description
isPublic
ListFlavor {
...ListFlavorFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"flavorList": {
"id": 987,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"description": "abc123",
"isPublic": true,
"ListFlavor": [ListFlavor]
}
}
}
flavorLists
Response
Returns a FlavorListNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
sort - SortMultiple
|
Example
Query
query flavorLists(
$limit: Int,
$offset: Int,
$sort: SortMultiple
) {
flavorLists(
limit: $limit,
offset: $offset,
sort: $sort
) {
totalCount
count
nodes {
...FlavorListFragment
}
}
}
Variables
{"limit": 123, "offset": 123, "sort": SortMultiple}
Response
{
"data": {
"flavorLists": {
"totalCount": 987,
"count": 123,
"nodes": [FlavorList]
}
}
}
flavorNote
Response
Returns a FlavorNote
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query flavorNote($id: Int) {
flavorNote(id: $id) {
id
userId
flavorId
createdAt
updatedAt
notes
shared
steep
score
difficulty
ratingUp
ratingDown
solo
mix
equipment
method
profile
pairing
Flavor {
...FlavorFragment
}
User {
...UserFragment
}
Vendor {
...VendorFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"flavorNote": {
"id": 987,
"userId": 123,
"flavorId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"notes": "xyz789",
"shared": false,
"steep": 987,
"score": 123,
"difficulty": 987,
"ratingUp": 987,
"ratingDown": 123,
"solo": 123.45,
"mix": 987.65,
"equipment": "xyz789",
"method": "xyz789",
"profile": "abc123",
"pairing": "xyz789",
"Flavor": Flavor,
"User": User,
"Vendor": Vendor
}
}
}
flavorNotes
Response
Returns a FlavorNoteNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - FlavorNoteFilter
|
|
sort - SortMultiple
|
Example
Query
query flavorNotes(
$limit: Int,
$offset: Int,
$filter: FlavorNoteFilter,
$sort: SortMultiple
) {
flavorNotes(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...FlavorNoteFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"filter": FlavorNoteFilter,
"sort": SortMultiple
}
Response
{
"data": {
"flavorNotes": {
"storage": "abc123",
"totalCount": 987,
"count": 123,
"nodes": [FlavorNote]
}
}
}
flavorStash
Response
Returns a FlavorStashNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - FlavorStashFilter
|
|
sort - SortMultiple
|
Example
Query
query flavorStash(
$limit: Int,
$offset: Int,
$filter: FlavorStashFilter,
$sort: SortMultiple
) {
flavorStash(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...FlavorStashFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"filter": FlavorStashFilter,
"sort": SortMultiple
}
Response
{
"data": {
"flavorStash": {
"storage": "xyz789",
"totalCount": 123,
"count": 987,
"nodes": [FlavorStash]
}
}
}
flavors
Response
Returns a FlavorNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - FlavorFilter
|
|
sort - SortMultiple
|
Example
Query
query flavors(
$limit: Int,
$offset: Int,
$filter: FlavorFilter,
$sort: SortMultiple
) {
flavors(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...FlavorFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"filter": FlavorFilter,
"sort": SortMultiple
}
Response
{
"data": {
"flavors": {
"storage": "xyz789",
"totalCount": 123,
"count": 123,
"nodes": [Flavor]
}
}
}
flavorsMatch
Response
Returns [FlavorMatch]
Arguments
| Name | Description |
|---|---|
type - String
|
|
flavors - [FlavorMatchExternalNames]
|
Example
Query
query flavorsMatch(
$type: String,
$flavors: [FlavorMatchExternalNames]
) {
flavorsMatch(
type: $type,
flavors: $flavors
) {
flavorId
percent
flavor {
...RequestedFlavorMatchFragment
}
Flavor {
...FlavorFragment
}
Errors
Flavors {
...FlavorFragment
}
}
}
Variables
{
"type": "xyz789",
"flavors": [FlavorMatchExternalNames]
}
Response
{
"data": {
"flavorsMatch": [
{
"flavorId": 987,
"percent": 123.45,
"flavor": RequestedFlavorMatch,
"Flavor": Flavor,
"Errors": {},
"Flavors": [Flavor]
}
]
}
}
flavorsStashOrder
Response
Returns [Flavor]
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - FlavorFilter
|
Example
Query
query flavorsStashOrder(
$limit: Int,
$offset: Int,
$filter: FlavorFilter
) {
flavorsStashOrder(
limit: $limit,
offset: $offset,
filter: $filter
) {
id
vendorId
density
createdAt
updatedAt
name
slug
rating
ratings
url
views
favorites
averageMillipercent
baseId
recipes
recMinMillipercent
recMaxMillipercent
vendorMillipercent
vendorUrl
discontinued
isFavorite
isStashed
FlavorStash {
...FlavorStashFragment
}
stashes
Vendor {
...VendorFragment
}
FlavorBase {
...IngredientFragment
}
RetailFlavor {
...RetailFlavorFragment
}
Sellers {
...RetailFlavorFragment
}
vendorPercent
flavorUsage
FlavorTag {
...FlavorTagFragment
}
}
}
Variables
{"limit": 123, "offset": 987, "filter": FlavorFilter}
Response
{
"data": {
"flavorsStashOrder": [
{
"id": 123,
"vendorId": 123,
"density": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"slug": "abc123",
"rating": 987.65,
"ratings": 987,
"url": "abc123",
"views": 987,
"favorites": 123,
"averageMillipercent": 123,
"baseId": 123,
"recipes": 123,
"recMinMillipercent": 987,
"recMaxMillipercent": 987,
"vendorMillipercent": 987,
"vendorUrl": "abc123",
"discontinued": false,
"isFavorite": true,
"isStashed": false,
"FlavorStash": FlavorStash,
"stashes": 987,
"Vendor": Vendor,
"FlavorBase": Ingredient,
"RetailFlavor": RetailFlavor,
"Sellers": [RetailFlavor],
"vendorPercent": 123.45,
"flavorUsage": {},
"FlavorTag": [FlavorTag]
}
]
}
}
folder
Example
Query
query folder($id: Int) {
folder(id: $id) {
id
userId
createdAt
updatedAt
name
description
FolderRecipe {
...FolderRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"folder": {
"id": 987,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"description": "abc123",
"FolderRecipe": [FolderRecipe],
"User": User
}
}
}
folders
Response
Returns a FolderNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
sort - SortMultiple
|
Example
Query
query folders(
$limit: Int,
$offset: Int,
$sort: SortMultiple
) {
folders(
limit: $limit,
offset: $offset,
sort: $sort
) {
totalCount
count
nodes {
...FolderFragment
}
}
}
Variables
{"limit": 987, "offset": 123, "sort": SortMultiple}
Response
{
"data": {
"folders": {
"totalCount": 123,
"count": 987,
"nodes": [Folder]
}
}
}
foldersList
Response
Returns [Folder]
Example
Query
query foldersList {
foldersList {
id
userId
createdAt
updatedAt
name
description
FolderRecipe {
...FolderRecipeFragment
}
User {
...UserFragment
}
}
}
Response
{
"data": {
"foldersList": [
{
"id": 987,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"description": "xyz789",
"FolderRecipe": [FolderRecipe],
"User": User
}
]
}
}
formulation
Response
Returns a Formulation
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query formulation($id: Int) {
formulation(id: $id) {
id
name
userId
createdAt
updatedAt
isPublished
description
favorites
mixes
flavorMultiplier
isOriginal
adaptedId
communityDefault
isFavorite
recommendedBy
recipes
recipeUserId
RecipeFormulation {
...RecipeFormulationFragment
}
relationship {
...SimpleRecipeFormulationFragment
}
FormulationIngredient {
...FormulationIngredientFragment
}
User {
...UserFragment
}
AdaptedFormulation {
...AdaptedFormulationFragment
}
FormulationTag {
...FormulationTagFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"formulation": {
"id": 123,
"name": "abc123",
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"isPublished": true,
"description": "abc123",
"favorites": 123,
"mixes": 987,
"flavorMultiplier": 987.65,
"isOriginal": false,
"adaptedId": 987,
"communityDefault": true,
"isFavorite": true,
"recommendedBy": {},
"recipes": 123,
"recipeUserId": 123,
"RecipeFormulation": [RecipeFormulation],
"relationship": SimpleRecipeFormulation,
"FormulationIngredient": [FormulationIngredient],
"User": User,
"AdaptedFormulation": AdaptedFormulation,
"FormulationTag": [FormulationTag]
}
}
}
formulations
Response
Returns a FormulationNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - FormulationFilter
|
Formulation Filters |
sort - SortMultiple
|
Formulation Sort |
Example
Query
query formulations(
$limit: Int,
$offset: Int,
$filter: FormulationFilter,
$sort: SortMultiple
) {
formulations(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
recipeId
recipeUserId
nodes {
...FormulationFragment
}
}
}
Variables
{
"limit": 987,
"offset": 987,
"filter": FormulationFilter,
"sort": SortMultiple
}
Response
{
"data": {
"formulations": {
"storage": "xyz789",
"totalCount": 987,
"count": 123,
"recipeId": 987,
"recipeUserId": 123,
"nodes": [Formulation]
}
}
}
forum
Example
Query
query forum(
$id: Int,
$slug: String
) {
forum(
id: $id,
slug: $slug
) {
id
userId
createdAt
updatedAt
title
slug
description
image
parentId
allowTopics
externalData
locked
topics
comments
itemTypeId
lastActivityAt
rating
ratingUp
ratingDown
dataSchema
meta
Forum {
...ParentForumFragment
}
Forums {
...ChildForumFragment
}
}
}
Variables
{"id": 987, "slug": "abc123"}
Response
{
"data": {
"forum": {
"id": 987,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"slug": "xyz789",
"description": "xyz789",
"image": "xyz789",
"parentId": 987,
"allowTopics": true,
"externalData": false,
"locked": true,
"topics": 123,
"comments": 987,
"itemTypeId": 123,
"lastActivityAt": "2007-12-03T10:15:30Z",
"rating": 123,
"ratingUp": 123,
"ratingDown": 123,
"dataSchema": "xyz789",
"meta": {},
"Forum": ParentForum,
"Forums": [ChildForum]
}
}
}
forumComment
Response
Returns a ForumComment
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query forumComment($id: Int) {
forumComment(id: $id) {
id
createdAt
updatedAt
rating
forumId
topicId
parentId
authorId
locked
ratingUp
ratingDown
threadPath
bodyText
body
meta
Forum {
...ForumFragment
}
ForumTopic {
...ForumTopicFragment
}
ForumComment {
...ParentCommentFragment
}
ForumComments {
...ChildCommentFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"forumComment": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"forumId": 987,
"topicId": 987,
"parentId": 123,
"authorId": 123,
"locked": false,
"ratingUp": 987,
"ratingDown": 987,
"threadPath": "xyz789",
"bodyText": "abc123",
"body": {},
"meta": {},
"Forum": Forum,
"ForumTopic": ForumTopic,
"ForumComment": ParentComment,
"ForumComments": ChildComment,
"User": User
}
}
}
forumComments
Response
Returns a ForumCommentNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - ForumCommentFilter
|
|
sort - Sort
|
Example
Query
query forumComments(
$limit: Int,
$offset: Int,
$filter: ForumCommentFilter,
$sort: Sort
) {
forumComments(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...ForumCommentFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"filter": ForumCommentFilter,
"sort": Sort
}
Response
{
"data": {
"forumComments": {
"storage": "xyz789",
"totalCount": 987,
"count": 987,
"nodes": [ForumComment]
}
}
}
forumRecipes
Response
Returns a RecipeNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - RecipeCommentFilter
|
|
sort - Sort
|
Example
Query
query forumRecipes(
$limit: Int,
$offset: Int,
$filter: RecipeCommentFilter,
$sort: Sort
) {
forumRecipes(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...RecipeFragment
}
}
}
Variables
{
"limit": 987,
"offset": 987,
"filter": RecipeCommentFilter,
"sort": Sort
}
Response
{
"data": {
"forumRecipes": {
"storage": "abc123",
"totalCount": 123,
"count": 987,
"nodes": [Recipe]
}
}
}
forumRecipesSummary
Response
Returns a ForumRecipesSummary
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - RecipeCommentFilter
|
|
sort - Sort
|
Example
Query
query forumRecipesSummary(
$limit: Int,
$offset: Int,
$filter: RecipeCommentFilter,
$sort: Sort
) {
forumRecipesSummary(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
recipes
comments
}
}
Variables
{
"limit": 987,
"offset": 123,
"filter": RecipeCommentFilter,
"sort": Sort
}
Response
{"data": {"forumRecipesSummary": {"recipes": 987, "comments": 123}}}
forumTopic
Response
Returns a ForumTopic
Example
Query
query forumTopic(
$id: Int,
$slug: String
) {
forumTopic(
id: $id,
slug: $slug
) {
id
createdAt
updatedAt
title
slug
forumId
authorId
locked
pinned
comments
views
rating
ratingUp
ratingDown
bodyText
body
lastActivityAt
meta
Forum {
...ForumFragment
}
ForumComment {
...ForumCommentFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 987, "slug": "xyz789"}
Response
{
"data": {
"forumTopic": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"slug": "abc123",
"forumId": 123,
"authorId": 123,
"locked": true,
"pinned": true,
"comments": 123,
"views": 123,
"rating": 123,
"ratingUp": 987,
"ratingDown": 123,
"bodyText": "xyz789",
"body": {},
"lastActivityAt": "2007-12-03T10:15:30Z",
"meta": {},
"Forum": Forum,
"ForumComment": ForumComment,
"User": User
}
}
}
forumTopics
Response
Returns a ForumTopicNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - ForumTopicFilter
|
|
sort - Sort
|
Example
Query
query forumTopics(
$limit: Int,
$offset: Int,
$filter: ForumTopicFilter,
$sort: Sort
) {
forumTopics(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...ForumTopicFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"filter": ForumTopicFilter,
"sort": Sort
}
Response
{
"data": {
"forumTopics": {
"storage": "abc123",
"totalCount": 987,
"count": 987,
"nodes": [ForumTopic]
}
}
}
forums
Response
Returns a ForumNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - ForumFilter
|
|
sort - Sort
|
Example
Query
query forums(
$limit: Int,
$offset: Int,
$filter: ForumFilter,
$sort: Sort
) {
forums(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...ForumFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"filter": ForumFilter,
"sort": Sort
}
Response
{
"data": {
"forums": {
"storage": "abc123",
"totalCount": 987,
"count": 987,
"nodes": [Forum]
}
}
}
ingredient
Response
Returns an Ingredient
Example
Query
query ingredient(
$id: Int,
$slug: String,
$code: String
) {
ingredient(
id: $id,
slug: $slug,
code: $code
) {
id
active
ingredientTypeId
vendorId
density
code
createdAt
updatedAt
name
slug
description
image
discontinued
IngredientActive {
...IngredientActiveIngredientDefFragment
}
IngredientBase {
...IngredientBaseIngredientDefFragment
}
IngredientStash {
...IngredientStashFragment
}
IngredientType {
...IngredientTypeFragment
}
isStashed
stashes
Vendor {
...VendorFragment
}
IngredientTag {
...IngredientTagFragment
}
}
}
Variables
{
"id": 987,
"slug": "abc123",
"code": "abc123"
}
Response
{
"data": {
"ingredient": {
"id": 123,
"active": false,
"ingredientTypeId": 123,
"vendorId": 987,
"density": 123.45,
"code": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"slug": "xyz789",
"description": "abc123",
"image": "abc123",
"discontinued": false,
"IngredientActive": [IngredientActiveIngredientDef],
"IngredientBase": [IngredientBaseIngredientDef],
"IngredientStash": IngredientStash,
"IngredientType": IngredientType,
"isStashed": false,
"stashes": 123,
"Vendor": Vendor,
"IngredientTag": [IngredientTag]
}
}
}
ingredientStash
Response
Returns an IngredientStashNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - IngredientStashFilter
|
|
sort - SortMultiple
|
Example
Query
query ingredientStash(
$limit: Int,
$offset: Int,
$filter: IngredientStashFilter,
$sort: SortMultiple
) {
ingredientStash(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...IngredientStashFragment
}
}
}
Variables
{
"limit": 123,
"offset": 123,
"filter": IngredientStashFilter,
"sort": SortMultiple
}
Response
{
"data": {
"ingredientStash": {
"storage": "abc123",
"totalCount": 123,
"count": 123,
"nodes": [IngredientStash]
}
}
}
ingredientType
Response
Returns an IngredientType
Example
Query
query ingredientType(
$id: Int,
$slug: String
) {
ingredientType(
id: $id,
slug: $slug
) {
id
name
slug
description
}
}
Variables
{"id": 123, "slug": "abc123"}
Response
{
"data": {
"ingredientType": {
"id": 987,
"name": "abc123",
"slug": "abc123",
"description": "xyz789"
}
}
}
ingredientTypes
Response
Returns an IngredientTypeNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - IngredientTypeFilter
|
|
sort - Sort
|
Example
Query
query ingredientTypes(
$limit: Int,
$offset: Int,
$filter: IngredientTypeFilter,
$sort: Sort
) {
ingredientTypes(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
totalCount
count
nodes {
...IngredientTypeFragment
}
}
}
Variables
{
"limit": 987,
"offset": 987,
"filter": IngredientTypeFilter,
"sort": Sort
}
Response
{
"data": {
"ingredientTypes": {
"totalCount": 123,
"count": 987,
"nodes": [IngredientType]
}
}
}
ingredients
Response
Returns an IngredientNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - IngredientFilter
|
|
sort - SortMultiple
|
Example
Query
query ingredients(
$limit: Int,
$offset: Int,
$filter: IngredientFilter,
$sort: SortMultiple
) {
ingredients(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
totalCount
count
nodes {
...IngredientFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"filter": IngredientFilter,
"sort": SortMultiple
}
Response
{
"data": {
"ingredients": {
"totalCount": 987,
"count": 123,
"nodes": [Ingredient]
}
}
}
itemAction
Response
Returns an ItemAction
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query itemAction($id: Int) {
itemAction(id: $id) {
id
name
slug
action
description
}
}
Variables
{"id": 123}
Response
{
"data": {
"itemAction": {
"id": 123,
"name": "abc123",
"slug": "abc123",
"action": "abc123",
"description": "xyz789"
}
}
}
itemActions
Response
Returns [ItemAction]
Example
Query
query itemActions {
itemActions {
id
name
slug
action
description
}
}
Response
{
"data": {
"itemActions": [
{
"id": 123,
"name": "xyz789",
"slug": "abc123",
"action": "abc123",
"description": "abc123"
}
]
}
}
itemType
Example
Query
query itemType(
$id: Int,
$name: String
) {
itemType(
id: $id,
name: $name
) {
id
name
slug
description
}
}
Variables
{"id": 123, "name": "abc123"}
Response
{
"data": {
"itemType": {
"id": 987,
"name": "xyz789",
"slug": "abc123",
"description": "xyz789"
}
}
}
itemTypes
Response
Returns [ItemType]
Example
Query
query itemTypes {
itemTypes {
id
name
slug
description
}
}
Response
{
"data": {
"itemTypes": [
{
"id": 987,
"name": "abc123",
"slug": "abc123",
"description": "abc123"
}
]
}
}
license
Example
Query
query license($id: Int) {
license(id: $id) {
id
createdAt
updatedAt
name
url
recipes
imageUrl
adaptable
attribution
commercial
recipesCount
licenseType
explanation
}
}
Variables
{"id": 987}
Response
{
"data": {
"license": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"url": "xyz789",
"recipes": 123,
"imageUrl": "abc123",
"adaptable": true,
"attribution": true,
"commercial": false,
"recipesCount": 123,
"licenseType": "abc123",
"explanation": "abc123"
}
}
}
licenses
Response
Returns [License]
Example
Query
query licenses {
licenses {
id
createdAt
updatedAt
name
url
recipes
imageUrl
adaptable
attribution
commercial
recipesCount
licenseType
explanation
}
}
Response
{
"data": {
"licenses": [
{
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"url": "abc123",
"recipes": 987,
"imageUrl": "xyz789",
"adaptable": false,
"attribution": true,
"commercial": true,
"recipesCount": 987,
"licenseType": "xyz789",
"explanation": "abc123"
}
]
}
}
masterTag
Description
Tag
Example
Query
query masterTag(
$id: Int,
$name: String
) {
masterTag(
id: $id,
name: $name
) {
id
parentId
active
name
createdAt
updatedAt
confirmed
aliasId
tier
path
meta
childDepth
Alias {
...TagBaseFragment
}
FlavorTag {
...FlavorTagFragment
}
FormulationTag {
...FormulationTagFragment
}
IngredientTag {
...IngredientTagFragment
}
Parent {
...TagBaseFragment
}
RecipeTag {
...RecipeTagFragment
}
Tags {
...TagBaseFragment
}
}
}
Variables
{"id": 123, "name": "xyz789"}
Response
{
"data": {
"masterTag": {
"id": 987,
"parentId": 987,
"active": true,
"name": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"confirmed": true,
"aliasId": 123,
"tier": 987,
"path": "xyz789",
"meta": {},
"childDepth": 987,
"Alias": TagBase,
"FlavorTag": FlavorTag,
"FormulationTag": FormulationTag,
"IngredientTag": IngredientTag,
"Parent": TagBase,
"RecipeTag": RecipeTag,
"Tags": [TagBase]
}
}
}
masterTags
Description
Tags
Response
Returns a TagNode
Example
Query
query masterTags(
$filter: TagFilter,
$offset: Int,
$limit: Int,
$sort: Sort
) {
masterTags(
filter: $filter,
offset: $offset,
limit: $limit,
sort: $sort
) {
storage
totalCount
count
nodes {
...TagFragment
}
}
}
Variables
{
"filter": TagFilter,
"offset": 987,
"limit": 987,
"sort": Sort
}
Response
{
"data": {
"masterTags": {
"storage": 123,
"totalCount": 987,
"count": 123,
"nodes": [Tag]
}
}
}
message
Description
Get a Message Thread
Response
Returns a MessageThread
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query message($id: Int) {
message(id: $id) {
id
createdAt
updatedAt
archived
locked
subject
support
report
ticketId
MessageUser {
...MessageUserFragment
}
Message {
...MessageFragment
}
Ticket {
...TicketFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"message": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"archived": true,
"locked": false,
"subject": "xyz789",
"support": false,
"report": true,
"ticketId": 123,
"MessageUser": [MessageUser],
"Message": [Message],
"Ticket": Ticket,
"User": User
}
}
}
messageCounts
Description
Get a User's Message Threads
Response
Returns a MessageCounts
Example
Query
query messageCounts {
messageCounts {
inbox
support
report
totalCount
}
}
Response
{
"data": {
"messageCounts": {
"inbox": 987,
"support": 123,
"report": 123,
"totalCount": 123
}
}
}
messages
Description
Get a User's Message Threads
Response
Returns a MessageNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - MessageFilter
|
|
sort - Sort
|
Example
Query
query messages(
$limit: Int,
$offset: Int,
$filter: MessageFilter,
$sort: Sort
) {
messages(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
totalCount
count
isArchived
nodes {
...MessageUserFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"filter": MessageFilter,
"sort": Sort
}
Response
{
"data": {
"messages": {
"totalCount": 123,
"count": 987,
"isArchived": true,
"nodes": [MessageUser]
}
}
}
myFlavorLists
Response
Returns [FlavorList]
Example
Query
query myFlavorLists {
myFlavorLists {
id
userId
createdAt
updatedAt
name
description
isPublic
ListFlavor {
...ListFlavorFragment
}
}
}
Response
{
"data": {
"myFlavorLists": [
{
"id": 987,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"description": "abc123",
"isPublic": false,
"ListFlavor": [ListFlavor]
}
]
}
}
recipe
Description
Get a Recipe by Slug or ID
Example
Query
query recipe(
$id: Int,
$slug: String
) {
recipe(
id: $id,
slug: $slug
) {
id
isPublished
userId
createdAt
deletedAt
updatedAt
rating
ratings
name
image
shareKey
slug
description
favorites
steepDays
color
isShared
isOriginal
isInProgress
isMTL
isSNV
licenseId
revisions
adaptedId
flavors
mixes
notes
publishedAt
restricted
restrictedAt
restrictedReason
totalMillipercent
views
comments
imageUrl
imageThumb
isFavorite
recipeShare
flavorCount
totalPercent
License {
...LicenseFragment
}
RecipeBadge {
...BadgeAssignedToItemFragment
}
RecipeFlavor {
...RecipeFlavorFragment
}
User {
...UserFragment
}
AdaptedRecipe {
...SimpleRecipeFragment
}
RecipeTag {
...RecipeTagFragment
}
}
}
Variables
{"id": 987, "slug": "abc123"}
Response
{
"data": {
"recipe": {
"id": 987,
"isPublished": true,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"ratings": 987,
"name": "abc123",
"image": "xyz789",
"shareKey": "abc123",
"slug": "xyz789",
"description": "xyz789",
"favorites": 987,
"steepDays": 123,
"color": "abc123",
"isShared": true,
"isOriginal": true,
"isInProgress": true,
"isMTL": false,
"isSNV": true,
"licenseId": 123,
"revisions": 123,
"adaptedId": 123,
"flavors": 987,
"mixes": 987,
"notes": {},
"publishedAt": "2007-12-03T10:15:30Z",
"restricted": true,
"restrictedAt": "2007-12-03T10:15:30Z",
"restrictedReason": "abc123",
"totalMillipercent": 123.45,
"views": 987,
"comments": 123,
"imageUrl": "xyz789",
"imageThumb": "xyz789",
"isFavorite": true,
"recipeShare": {},
"flavorCount": 123,
"totalPercent": 123.45,
"License": License,
"RecipeBadge": [BadgeAssignedToItem],
"RecipeFlavor": [RecipeFlavor],
"User": User,
"AdaptedRecipe": SimpleRecipe,
"RecipeTag": [RecipeTag]
}
}
}
recipeComment
Response
Returns a RecipeComment
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query recipeComment($id: Int) {
recipeComment(id: $id) {
id
recipeId
createdAt
updatedAt
title
rating
locked
parentId
authorId
ratingUp
ratingDown
threadPath
bodyText
body
meta
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"recipeComment": {
"id": 987,
"recipeId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"rating": 987.65,
"locked": false,
"parentId": 123,
"authorId": 123,
"ratingUp": 123,
"ratingDown": 123,
"threadPath": "xyz789",
"bodyText": "abc123",
"body": {},
"meta": {},
"Recipe": SimpleRecipe,
"User": User
}
}
}
recipeComments
Response
Returns a RecipeCommentNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - RecipeCommentFilter
|
|
sort - Sort
|
Example
Query
query recipeComments(
$limit: Int,
$offset: Int,
$filter: RecipeCommentFilter,
$sort: Sort
) {
recipeComments(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...RecipeCommentFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"filter": RecipeCommentFilter,
"sort": Sort
}
Response
{
"data": {
"recipeComments": {
"storage": "abc123",
"totalCount": 987,
"count": 987,
"nodes": [RecipeComment]
}
}
}
recipeFormulation
Description
Get a Recipe Formulation
Response
Returns a RecipeFormulation
Example
Query
query recipeFormulation(
$recipeId: Int,
$formulationId: Int
) {
recipeFormulation(
recipeId: $recipeId,
formulationId: $formulationId
) {
recipeId
formulationId
createdAt
updatedAt
recCount
recUsers
Recipe {
...SimpleRecipeFragment
}
Formulation {
...FormulationFragment
}
}
}
Variables
{"recipeId": 123, "formulationId": 987}
Response
{
"data": {
"recipeFormulation": {
"recipeId": 123,
"formulationId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"recCount": 123,
"recUsers": {},
"Recipe": SimpleRecipe,
"Formulation": Formulation
}
}
}
recipeFormulations
Description
Get Recipe Formulations
Response
Returns a RecipeFormulationNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - RecipeFormulationFilter
|
Recipe Formulation Filters |
Example
Query
query recipeFormulations(
$limit: Int,
$offset: Int,
$filter: RecipeFormulationFilter
) {
recipeFormulations(
limit: $limit,
offset: $offset,
filter: $filter
) {
storage
totalCount
count
nodes {
...RecipeFormulationFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"filter": RecipeFormulationFilter
}
Response
{
"data": {
"recipeFormulations": {
"storage": "xyz789",
"totalCount": 123,
"count": 123,
"nodes": [RecipeFormulation]
}
}
}
recipeStats
Description
Get Recipes
Response
Returns a RecipeStatNode
Example
Query
query recipeStats(
$id: Int,
$slug: String,
$limit: Int,
$offset: Int,
$filter: String,
$sort: Sort
) {
recipeStats(
id: $id,
slug: $slug,
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
nodes {
...RecipeStatDefFragment
}
}
}
Variables
{
"id": 987,
"slug": "xyz789",
"limit": 123,
"offset": 987,
"filter": "xyz789",
"sort": Sort
}
Response
{"data": {"recipeStats": {"nodes": [RecipeStatDef]}}}
recipes
Description
Get Recipes
Response
Returns a RecipeNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - RecipeFilter
|
Recipe Filters |
sort - SortMultiple
|
Recipe Sort |
Example
Query
query recipes(
$limit: Int,
$offset: Int,
$filter: RecipeFilter,
$sort: SortMultiple
) {
recipes(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...RecipeFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"filter": RecipeFilter,
"sort": SortMultiple
}
Response
{
"data": {
"recipes": {
"storage": "abc123",
"totalCount": 987,
"count": 987,
"nodes": [Recipe]
}
}
}
recipesCount
Description
Get Recipes Count
Response
Returns a RecipeNode
Example
Query
query recipesCount {
recipesCount {
storage
totalCount
count
nodes {
...RecipeFragment
}
}
}
Response
{
"data": {
"recipesCount": {
"storage": "abc123",
"totalCount": 123,
"count": 987,
"nodes": [Recipe]
}
}
}
retailFlavors
Response
Returns a FlavorNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - RetailFlavorFilter
|
|
sort - SortMultiple
|
Example
Query
query retailFlavors(
$limit: Int,
$offset: Int,
$filter: RetailFlavorFilter,
$sort: SortMultiple
) {
retailFlavors(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...FlavorFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"filter": RetailFlavorFilter,
"sort": SortMultiple
}
Response
{
"data": {
"retailFlavors": {
"storage": "abc123",
"totalCount": 123,
"count": 123,
"nodes": [Flavor]
}
}
}
retailVendor
Response
Returns a RetailVendor
Example
Query
query retailVendor(
$id: Int,
$sellerId: Int,
$vendorId: Int
) {
retailVendor(
id: $id,
sellerId: $sellerId,
vendorId: $vendorId
) {
id
createdAt
updatedAt
vendorId
slug
active
sellerId
flavorUrlPattern
ingredientUrlPattern
clicks
meta
Flavor {
...FlavorFragment
}
Vendor_RetailVendor_sellerIdToVendor {
...VendorFragment
}
Vendor_RetailVendor_vendorIdToVendor {
...VendorFragment
}
}
}
Variables
{"id": 987, "sellerId": 987, "vendorId": 987}
Response
{
"data": {
"retailVendor": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"vendorId": 123,
"slug": "abc123",
"active": false,
"sellerId": 987,
"flavorUrlPattern": "abc123",
"ingredientUrlPattern": "abc123",
"clicks": 123,
"meta": {},
"Flavor": Flavor,
"Vendor_RetailVendor_sellerIdToVendor": Vendor,
"Vendor_RetailVendor_vendorIdToVendor": Vendor
}
}
}
retailVendors
Response
Returns a RetailVendorNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - RetailVendorFilter
|
|
sort - Sort
|
Example
Query
query retailVendors(
$limit: Int,
$offset: Int,
$filter: RetailVendorFilter,
$sort: Sort
) {
retailVendors(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...RetailVendorFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"filter": RetailVendorFilter,
"sort": Sort
}
Response
{
"data": {
"retailVendors": {
"storage": "xyz789",
"totalCount": 987,
"count": 123,
"nodes": [RetailVendor]
}
}
}
review
Response
Returns a Review
Example
Query
query review(
$type: String,
$id: Int,
$flavorId: Int,
$recipeId: Int,
$vendorId: Int,
$mixerId: Int
) {
review(
type: $type,
id: $id,
flavorId: $flavorId,
recipeId: $recipeId,
vendorId: $vendorId,
mixerId: $mixerId
) {
id
userId
rating
createdAt
updatedAt
title
body
User {
...UserFragment
}
}
}
Variables
{
"type": "abc123",
"id": 123,
"flavorId": 987,
"recipeId": 123,
"vendorId": 123,
"mixerId": 123
}
Response
{
"data": {
"review": {
"id": 987,
"userId": 123,
"rating": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"body": "xyz789",
"User": User
}
}
}
reviews
Response
Returns a ReviewNode
Arguments
| Name | Description |
|---|---|
type - String
|
|
limit - Int
|
|
offset - Int
|
|
filter - ReviewFilter
|
|
sort - Sort
|
Example
Query
query reviews(
$type: String,
$limit: Int,
$offset: Int,
$filter: ReviewFilter,
$sort: Sort
) {
reviews(
type: $type,
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
averageRating
storage
totalCount
count
nodes {
...ReviewFragment
}
}
}
Variables
{
"type": "xyz789",
"limit": 987,
"offset": 123,
"filter": ReviewFilter,
"sort": Sort
}
Response
{
"data": {
"reviews": {
"averageRating": 123.45,
"storage": "abc123",
"totalCount": 987,
"count": 123,
"nodes": [Review]
}
}
}
role
rolePermission
Response
Returns a RolePermission
Example
Query
query rolePermission(
$roleId: Int,
$permissionSubjectId: Int,
$permissionActionId: Int
) {
rolePermission(
roleId: $roleId,
permissionSubjectId: $permissionSubjectId,
permissionActionId: $permissionActionId
) {
roleId
permissionSubjectId
permissionActionId
inverted
conditions
reason
ItemType {
...ItemTypeFragment
}
ItemAction {
...ItemActionFragment
}
Role {
...RoleFragment
}
}
}
Variables
{"roleId": 123, "permissionSubjectId": 987, "permissionActionId": 987}
Response
{
"data": {
"rolePermission": {
"roleId": 123,
"permissionSubjectId": 123,
"permissionActionId": 123,
"inverted": false,
"conditions": {},
"reason": "xyz789",
"ItemType": ItemType,
"ItemAction": ItemAction,
"Role": Role
}
}
}
rolePermissions
Response
Returns a RolePermissionNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - RolePermissionFilter
|
Role Users Filters |
sort - Sort
|
Role Users Sorting |
Example
Query
query rolePermissions(
$limit: Int,
$offset: Int,
$filter: RolePermissionFilter,
$sort: Sort
) {
rolePermissions(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...RolePermissionFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"filter": RolePermissionFilter,
"sort": Sort
}
Response
{
"data": {
"rolePermissions": {
"storage": 123,
"totalCount": 123,
"count": 123,
"nodes": [RolePermission]
}
}
}
roleUsers
Response
Returns a UserRoleNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - UserRoleFilter
|
Role Users Filters |
sort - Sort
|
Role Users Sorting |
Example
Query
query roleUsers(
$limit: Int,
$offset: Int,
$filter: UserRoleFilter,
$sort: Sort
) {
roleUsers(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...UserRoleFragment
}
}
}
Variables
{
"limit": 987,
"offset": 123,
"filter": UserRoleFilter,
"sort": Sort
}
Response
{
"data": {
"roleUsers": {
"storage": 987,
"totalCount": 987,
"count": 987,
"nodes": [UserRole]
}
}
}
roles
Description
Get Roles
Response
Returns a RoleNode
Example
Query
query roles {
roles {
count
totalCount
nodes {
...RoleFragment
}
}
}
Response
{
"data": {
"roles": {
"count": 123,
"totalCount": 987,
"nodes": [Role]
}
}
}
saleBatch
Example
Query
query saleBatch(
$id: Int,
$lot: String
) {
saleBatch(
id: $id,
lot: $lot
) {
id
userId
recipeId
createdAt
name
batchSize
amountRemaining
version
lot
data
desiredMixingPercent
isForSale
wasSold
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 987, "lot": "xyz789"}
Response
{
"data": {
"saleBatch": {
"id": 123,
"userId": 987,
"recipeId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"batchSize": 123.45,
"amountRemaining": 123.45,
"version": "xyz789",
"lot": "abc123",
"data": {},
"desiredMixingPercent": 987.65,
"isForSale": true,
"wasSold": true,
"Recipe": SimpleRecipe,
"User": User
}
}
}
saleBatches
Response
Returns a SaleBatchNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - BatchFilter
|
|
sort - SortMultiple
|
Example
Query
query saleBatches(
$limit: Int,
$offset: Int,
$filter: BatchFilter,
$sort: SortMultiple
) {
saleBatches(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
totalCount
count
nodes {
...SaleBatchFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"filter": BatchFilter,
"sort": SortMultiple
}
Response
{
"data": {
"saleBatches": {
"totalCount": 987,
"count": 987,
"nodes": [SaleBatch]
}
}
}
server
Response
Returns a ServerStatus
Example
Query
query server {
server {
status
}
}
Response
{"data": {"server": {"status": "xyz789"}}}
tagTypeInfo
Description
Tag Type Info
Response
Returns a TagTypeInfo
Arguments
| Name | Description |
|---|---|
type - String
|
Example
Query
query tagTypeInfo($type: String) {
tagTypeInfo(type: $type) {
tiers
}
}
Variables
{"type": "abc123"}
Response
{"data": {"tagTypeInfo": {"tiers": [987]}}}
topFlavors
Description
Get Flavors
Response
Returns a FlavorStatTopNode
Example
Query
query topFlavors(
$limit: Int,
$offset: Int,
$filter: String,
$sort: Sort
) {
topFlavors(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
nodes {
...FlavorStatTopDefFragment
}
}
}
Variables
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"sort": Sort
}
Response
{"data": {"topFlavors": {"nodes": [FlavorStatTopDef]}}}
topRecipes
Description
Get Recipes
Response
Returns a RecipeStatTopNode
Example
Query
query topRecipes(
$limit: Int,
$offset: Int,
$filter: String,
$sort: Sort
) {
topRecipes(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
nodes {
...RecipeStatTopDefFragment
}
}
}
Variables
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"sort": Sort
}
Response
{"data": {"topRecipes": {"nodes": [RecipeStatTopDef]}}}
unconfirmedFlavor
Response
Returns an UnconfirmedFlavor
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query unconfirmedFlavor($id: Int) {
unconfirmedFlavor(id: $id) {
id
vendorId
density
createdAt
name
url
userId
baseId
vendorMillipercent
Vendor {
...VendorFragment
}
vendorPercent
User {
...UserFragment
}
FlavorBase {
...IngredientFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"unconfirmedFlavor": {
"id": 123,
"vendorId": 123,
"density": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"url": "abc123",
"userId": 987,
"baseId": 987,
"vendorMillipercent": 123,
"Vendor": Vendor,
"vendorPercent": 123.45,
"User": User,
"FlavorBase": Ingredient
}
}
}
unconfirmedFlavors
Response
Returns an UnconfirmedFlavorNode
Example
Query
query unconfirmedFlavors(
$limit: Int,
$offset: Int
) {
unconfirmedFlavors(
limit: $limit,
offset: $offset
) {
storage
totalCount
count
nodes {
...UnconfirmedFlavorFragment
}
}
}
Variables
{"limit": 123, "offset": 987}
Response
{
"data": {
"unconfirmedFlavors": {
"storage": "abc123",
"totalCount": 987,
"count": 123,
"nodes": [UnconfirmedFlavor]
}
}
}
user
Description
Get a User
Example
Query
query user(
$id: Int,
$username: String
) {
user(
id: $id,
username: $username
) {
id
username
image
createdAt
updatedAt
description
favorites
recipes
rating
ratings
publicRecipes
flavors
interests
location
restricted
isFavorite
imageThumb
imageUrl
isFollowing
isFollower
followers
publicInventory
showFollowers
showFollowing
Country {
...CountryFragment
}
UserBadge {
...BadgeAssignedToItemFragment
}
UserRole {
...UserRoleFragment
}
}
}
Variables
{"id": 987, "username": "abc123"}
Response
{
"data": {
"user": {
"id": 987,
"username": "xyz789",
"image": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"favorites": 123,
"recipes": 987,
"rating": 987.65,
"ratings": 987,
"publicRecipes": 987,
"flavors": 123,
"interests": "abc123",
"location": 987,
"restricted": false,
"isFavorite": false,
"imageThumb": "xyz789",
"imageUrl": "xyz789",
"isFollowing": false,
"isFollower": false,
"followers": 987,
"publicInventory": false,
"showFollowers": false,
"showFollowing": true,
"Country": Country,
"UserBadge": [BadgeAssignedToItem],
"UserRole": [UserRole]
}
}
}
userAccount
Description
Get a User
Response
Returns a CurrentUser
Example
Query
query userAccount {
userAccount {
id
username
createdAt
updatedAt
email
banned
bannedAt
bannedEnd
bannedReason
bannedByUserId
confirmedAt
currentLoginDate
logins
prevLoginDate
resetAt
image
description
favorites
recipes
rating
ratings
publicRecipes
flavors
interests
location
restricted
settings
imageThumb
imageUrl
loggedIn
abilities
Session {
...SessionFragment
}
}
}
Response
{
"data": {
"userAccount": {
"id": 123,
"username": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "abc123",
"banned": false,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "abc123",
"bannedByUserId": 987,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 987,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z",
"image": "xyz789",
"description": "xyz789",
"favorites": 987,
"recipes": 123,
"rating": 123.45,
"ratings": 987,
"publicRecipes": 987,
"flavors": 987,
"interests": "xyz789",
"location": 123,
"restricted": false,
"settings": {},
"imageThumb": "xyz789",
"imageUrl": "xyz789",
"loggedIn": true,
"abilities": {},
"Session": [Session]
}
}
}
userAdmin
Description
Get a User for Administration
Example
Query
query userAdmin($id: Int) {
userAdmin(id: $id) {
id
username
createdAt
updatedAt
email
banned
bannedAt
bannedEnd
bannedReason
bannedByUserId
confirmedAt
currentLoginDate
logins
prevLoginDate
resetAt
image
description
favorites
recipes
rating
ratings
publicRecipes
flavors
interests
location
restricted
settings
imageThumb
imageUrl
Session {
...SessionFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"userAdmin": {
"id": 123,
"username": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "abc123",
"banned": false,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "xyz789",
"bannedByUserId": 987,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 987,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z",
"image": "xyz789",
"description": "xyz789",
"favorites": 987,
"recipes": 987,
"rating": 123.45,
"ratings": 123,
"publicRecipes": 123,
"flavors": 123,
"interests": "xyz789",
"location": 123,
"restricted": false,
"settings": {},
"imageThumb": "xyz789",
"imageUrl": "xyz789",
"Session": [Session]
}
}
}
userCheck
Description
Check if Username is available
Example
Query
query userCheck(
$id: Int,
$username: String,
$email: String
) {
userCheck(
id: $id,
username: $username,
email: $email
) {
id
username
image
createdAt
updatedAt
description
favorites
recipes
rating
ratings
publicRecipes
flavors
interests
location
restricted
isFavorite
imageThumb
imageUrl
isFollowing
isFollower
followers
publicInventory
showFollowers
showFollowing
Country {
...CountryFragment
}
UserBadge {
...BadgeAssignedToItemFragment
}
UserRole {
...UserRoleFragment
}
}
}
Variables
{
"id": 987,
"username": "xyz789",
"email": "xyz789"
}
Response
{
"data": {
"userCheck": {
"id": 123,
"username": "abc123",
"image": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"favorites": 987,
"recipes": 987,
"rating": 123.45,
"ratings": 987,
"publicRecipes": 987,
"flavors": 987,
"interests": "xyz789",
"location": 987,
"restricted": false,
"isFavorite": true,
"imageThumb": "xyz789",
"imageUrl": "xyz789",
"isFollowing": true,
"isFollower": true,
"followers": 987,
"publicInventory": false,
"showFollowers": true,
"showFollowing": false,
"Country": Country,
"UserBadge": [BadgeAssignedToItem],
"UserRole": [UserRole]
}
}
}
userRole
Example
Query
query userRole(
$userId: Int,
$roleId: Int
) {
userRole(
userId: $userId,
roleId: $roleId
) {
userId
active
roleId
Role {
...RoleFragment
}
User {
...UserFragment
}
}
}
Variables
{"userId": 123, "roleId": 987}
Response
{
"data": {
"userRole": {
"userId": 123,
"active": true,
"roleId": 987,
"Role": Role,
"User": User
}
}
}
userRoles
Response
Returns [UserRole]
Arguments
| Name | Description |
|---|---|
filter - UserRoleFilter
|
User Roles Filters |
sort - Sort
|
User Roles Sorting |
Example
Query
query userRoles(
$filter: UserRoleFilter,
$sort: Sort
) {
userRoles(
filter: $filter,
sort: $sort
) {
userId
active
roleId
Role {
...RoleFragment
}
User {
...UserFragment
}
}
}
Variables
{
"filter": UserRoleFilter,
"sort": Sort
}
Response
{
"data": {
"userRoles": [
{
"userId": 987,
"active": false,
"roleId": 987,
"Role": Role,
"User": User
}
]
}
}
users
Description
Get Users
Response
Returns a UserNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - UserFilter
|
Users Filters |
sort - Sort
|
Users Sorting |
Example
Query
query users(
$limit: Int,
$offset: Int,
$filter: UserFilter,
$sort: Sort
) {
users(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...UserFragment
}
}
}
Variables
{
"limit": 123,
"offset": 987,
"filter": UserFilter,
"sort": Sort
}
Response
{
"data": {
"users": {
"storage": 987,
"totalCount": 123,
"count": 987,
"nodes": [User]
}
}
}
usersCount
Description
Get Users
Response
Returns a UserNode
Example
Query
query usersCount {
usersCount {
storage
totalCount
count
nodes {
...UserFragment
}
}
}
Response
{
"data": {
"usersCount": {
"storage": 987,
"totalCount": 987,
"count": 123,
"nodes": [User]
}
}
}
vendor
Example
Query
query vendor(
$id: Int,
$slug: String,
$abbreviation: String
) {
vendor(
id: $id,
slug: $slug,
abbreviation: $abbreviation
) {
id
createdAt
updatedAt
name
description
favorites
rating
ratings
recipes
image
slug
active
abbreviation
vendorTypeId
location
couponCode
referralUrl
referralParam
flavorUrlPattern
ingredientUrlPattern
isFavorite
imageThumb
imageUrl
Country {
...CountryFragment
}
VendorBadge {
...BadgeAssignedToItemFragment
}
VendorType {
...VendorTypeFragment
}
VendorWebsite {
...VendorWebsiteFragment
}
}
}
Variables
{
"id": 123,
"slug": "abc123",
"abbreviation": "abc123"
}
Response
{
"data": {
"vendor": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"description": "abc123",
"favorites": 123,
"rating": 123.45,
"ratings": 987,
"recipes": 123,
"image": "abc123",
"slug": "xyz789",
"active": true,
"abbreviation": "xyz789",
"vendorTypeId": 123,
"location": 123,
"couponCode": "abc123",
"referralUrl": "abc123",
"referralParam": "xyz789",
"flavorUrlPattern": "xyz789",
"ingredientUrlPattern": "xyz789",
"isFavorite": false,
"imageThumb": "abc123",
"imageUrl": "xyz789",
"Country": Country,
"VendorBadge": [BadgeAssignedToItem],
"VendorType": VendorType,
"VendorWebsite": [VendorWebsite]
}
}
}
vendorType
Response
Returns a VendorType
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query vendorType($id: Int) {
vendorType(id: $id) {
id
name
slug
description
}
}
Variables
{"id": 123}
Response
{
"data": {
"vendorType": {
"id": 123,
"name": "xyz789",
"slug": "xyz789",
"description": "xyz789"
}
}
}
vendorTypes
Response
Returns [VendorType]
Example
Query
query vendorTypes {
vendorTypes {
id
name
slug
description
}
}
Response
{
"data": {
"vendorTypes": [
{
"id": 987,
"name": "abc123",
"slug": "abc123",
"description": "xyz789"
}
]
}
}
vendors
Response
Returns a VendorNode
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - VendorFilter
|
|
sort - Sort
|
Example
Query
query vendors(
$limit: Int,
$offset: Int,
$filter: VendorFilter,
$sort: Sort
) {
vendors(
limit: $limit,
offset: $offset,
filter: $filter,
sort: $sort
) {
storage
totalCount
count
nodes {
...VendorFragment
}
}
}
Variables
{
"limit": 987,
"offset": 987,
"filter": VendorFilter,
"sort": Sort
}
Response
{
"data": {
"vendors": {
"storage": "xyz789",
"totalCount": 123,
"count": 987,
"nodes": [Vendor]
}
}
}
Mutations
activateUser
Description
Activate New User
Response
Returns a UserActivate
Arguments
| Name | Description |
|---|---|
confirmKey - String
|
Example
Query
mutation activateUser($confirmKey: String) {
activateUser(confirmKey: $confirmKey) {
id
username
createdAt
updatedAt
email
banned
bannedAt
bannedEnd
bannedReason
bannedByUserId
confirmedAt
currentLoginDate
logins
prevLoginDate
resetAt
}
}
Variables
{"confirmKey": "xyz789"}
Response
{
"data": {
"activateUser": {
"id": 987,
"username": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "abc123",
"banned": true,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "xyz789",
"bannedByUserId": 987,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 987,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z"
}
}
}
archiveMessage
Description
Archive a Message Thread
Response
Returns a MessageThread
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation archiveMessage($id: Int) {
archiveMessage(id: $id) {
id
createdAt
updatedAt
archived
locked
subject
support
report
ticketId
MessageUser {
...MessageUserFragment
}
Message {
...MessageFragment
}
Ticket {
...TicketFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"archiveMessage": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"archived": true,
"locked": false,
"subject": "abc123",
"support": false,
"report": false,
"ticketId": 987,
"MessageUser": [MessageUser],
"Message": [Message],
"Ticket": Ticket,
"User": User
}
}
}
assignBadge
Description
Assign a Badge to an Item
Response
Returns an AssignBadge
Example
Query
mutation assignBadge(
$badgeId: Int,
$recipeId: Int,
$userId: Int,
$vendorId: Int,
$info: String
) {
assignBadge(
badgeId: $badgeId,
recipeId: $recipeId,
userId: $userId,
vendorId: $vendorId,
info: $info
) {
badgeId
Badge {
...BadgeFragment
}
}
}
Variables
{
"badgeId": 123,
"recipeId": 123,
"userId": 987,
"vendorId": 123,
"info": "abc123"
}
Response
{
"data": {
"assignBadge": {"badgeId": 987, "Badge": Badge}
}
}
assignDefaultFormulation
Description
Assign as Community Default
Response
Returns a Formulation
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation assignDefaultFormulation($id: Int) {
assignDefaultFormulation(id: $id) {
id
name
userId
createdAt
updatedAt
isPublished
description
favorites
mixes
flavorMultiplier
isOriginal
adaptedId
communityDefault
isFavorite
recommendedBy
recipes
recipeUserId
RecipeFormulation {
...RecipeFormulationFragment
}
relationship {
...SimpleRecipeFormulationFragment
}
FormulationIngredient {
...FormulationIngredientFragment
}
User {
...UserFragment
}
AdaptedFormulation {
...AdaptedFormulationFragment
}
FormulationTag {
...FormulationTagFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"assignDefaultFormulation": {
"id": 123,
"name": "xyz789",
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"isPublished": true,
"description": "abc123",
"favorites": 123,
"mixes": 987,
"flavorMultiplier": 123.45,
"isOriginal": false,
"adaptedId": 987,
"communityDefault": true,
"isFavorite": false,
"recommendedBy": {},
"recipes": 987,
"recipeUserId": 123,
"RecipeFormulation": [RecipeFormulation],
"relationship": SimpleRecipeFormulation,
"FormulationIngredient": [FormulationIngredient],
"User": User,
"AdaptedFormulation": AdaptedFormulation,
"FormulationTag": [FormulationTag]
}
}
}
assignTag
Description
Assign a Tag
Response
Returns a TagType
Example
Query
mutation assignTag(
$tagId: Int,
$flavorId: Int,
$formulationId: Int,
$ingredientId: Int,
$recipeId: Int,
$name: String,
$weight: Int,
$tags: JSON
) {
assignTag(
tagId: $tagId,
flavorId: $flavorId,
formulationId: $formulationId,
ingredientId: $ingredientId,
recipeId: $recipeId,
name: $name,
weight: $weight,
tags: $tags
) {
active
tagId
createdAt
updatedAt
userId
weight
rating
meta
}
}
Variables
{
"tagId": 123,
"flavorId": 987,
"formulationId": 123,
"ingredientId": 987,
"recipeId": 987,
"name": "abc123",
"weight": 987,
"tags": {}
}
Response
{
"data": {
"assignTag": {
"active": false,
"tagId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"userId": 123,
"weight": 987,
"rating": 987,
"meta": {}
}
}
}
cloneFormulation
Description
Clone a Formulation
Response
Returns a Formulation
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation cloneFormulation($id: Int) {
cloneFormulation(id: $id) {
id
name
userId
createdAt
updatedAt
isPublished
description
favorites
mixes
flavorMultiplier
isOriginal
adaptedId
communityDefault
isFavorite
recommendedBy
recipes
recipeUserId
RecipeFormulation {
...RecipeFormulationFragment
}
relationship {
...SimpleRecipeFormulationFragment
}
FormulationIngredient {
...FormulationIngredientFragment
}
User {
...UserFragment
}
AdaptedFormulation {
...AdaptedFormulationFragment
}
FormulationTag {
...FormulationTagFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"cloneFormulation": {
"id": 123,
"name": "xyz789",
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"isPublished": true,
"description": "xyz789",
"favorites": 987,
"mixes": 123,
"flavorMultiplier": 987.65,
"isOriginal": false,
"adaptedId": 987,
"communityDefault": false,
"isFavorite": false,
"recommendedBy": {},
"recipes": 123,
"recipeUserId": 123,
"RecipeFormulation": [RecipeFormulation],
"relationship": SimpleRecipeFormulation,
"FormulationIngredient": [FormulationIngredient],
"User": User,
"AdaptedFormulation": AdaptedFormulation,
"FormulationTag": [FormulationTag]
}
}
}
cloneRecipe
Description
Clone a Recipe
Example
Query
mutation cloneRecipe(
$id: Int,
$shareKey: String
) {
cloneRecipe(
id: $id,
shareKey: $shareKey
) {
id
isPublished
userId
createdAt
deletedAt
updatedAt
rating
ratings
name
image
shareKey
slug
description
favorites
steepDays
color
isShared
isOriginal
isInProgress
isMTL
isSNV
licenseId
revisions
adaptedId
flavors
mixes
notes
publishedAt
restricted
restrictedAt
restrictedReason
totalMillipercent
views
comments
imageUrl
imageThumb
isFavorite
recipeShare
flavorCount
totalPercent
License {
...LicenseFragment
}
RecipeBadge {
...BadgeAssignedToItemFragment
}
RecipeFlavor {
...RecipeFlavorFragment
}
User {
...UserFragment
}
AdaptedRecipe {
...SimpleRecipeFragment
}
RecipeTag {
...RecipeTagFragment
}
}
}
Variables
{"id": 987, "shareKey": "abc123"}
Response
{
"data": {
"cloneRecipe": {
"id": 987,
"isPublished": false,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"ratings": 987,
"name": "abc123",
"image": "xyz789",
"shareKey": "xyz789",
"slug": "abc123",
"description": "xyz789",
"favorites": 987,
"steepDays": 987,
"color": "abc123",
"isShared": false,
"isOriginal": true,
"isInProgress": true,
"isMTL": true,
"isSNV": true,
"licenseId": 123,
"revisions": 987,
"adaptedId": 987,
"flavors": 123,
"mixes": 123,
"notes": {},
"publishedAt": "2007-12-03T10:15:30Z",
"restricted": false,
"restrictedAt": "2007-12-03T10:15:30Z",
"restrictedReason": "abc123",
"totalMillipercent": 987.65,
"views": 987,
"comments": 123,
"imageUrl": "xyz789",
"imageThumb": "abc123",
"isFavorite": true,
"recipeShare": {},
"flavorCount": 987,
"totalPercent": 123.45,
"License": License,
"RecipeBadge": [BadgeAssignedToItem],
"RecipeFlavor": [RecipeFlavor],
"User": User,
"AdaptedRecipe": SimpleRecipe,
"RecipeTag": [RecipeTag]
}
}
}
confirmFlavor
Description
Confirm a Flavor
Example
Query
mutation confirmFlavor($id: Int) {
confirmFlavor(id: $id) {
id
vendorId
density
createdAt
updatedAt
name
slug
rating
ratings
url
views
favorites
averageMillipercent
baseId
recipes
recMinMillipercent
recMaxMillipercent
vendorMillipercent
vendorUrl
discontinued
isFavorite
isStashed
FlavorStash {
...FlavorStashFragment
}
stashes
Vendor {
...VendorFragment
}
FlavorBase {
...IngredientFragment
}
RetailFlavor {
...RetailFlavorFragment
}
Sellers {
...RetailFlavorFragment
}
vendorPercent
flavorUsage
FlavorTag {
...FlavorTagFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"confirmFlavor": {
"id": 123,
"vendorId": 987,
"density": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"slug": "xyz789",
"rating": 987.65,
"ratings": 987,
"url": "xyz789",
"views": 123,
"favorites": 123,
"averageMillipercent": 987,
"baseId": 123,
"recipes": 123,
"recMinMillipercent": 123,
"recMaxMillipercent": 123,
"vendorMillipercent": 123,
"vendorUrl": "abc123",
"discontinued": true,
"isFavorite": true,
"isStashed": false,
"FlavorStash": FlavorStash,
"stashes": 987,
"Vendor": Vendor,
"FlavorBase": Ingredient,
"RetailFlavor": RetailFlavor,
"Sellers": [RetailFlavor],
"vendorPercent": 123.45,
"flavorUsage": {},
"FlavorTag": [FlavorTag]
}
}
}
createBadge
Description
Create a New Badge
Response
Returns a Badge
Example
Query
mutation createBadge(
$type: String,
$supersedes: Int,
$name: String,
$image: String,
$icon: String,
$description: String
) {
createBadge(
type: $type,
supersedes: $supersedes,
name: $name,
image: $image,
icon: $icon,
description: $description
) {
id
createdAt
updatedAt
name
image
description
itemTypeId
supersedes
icon
ItemType {
...ItemTypeFragment
}
}
}
Variables
{
"type": "xyz789",
"supersedes": 123,
"name": "abc123",
"image": "abc123",
"icon": "abc123",
"description": "abc123"
}
Response
{
"data": {
"createBadge": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"image": "xyz789",
"description": "abc123",
"itemTypeId": 987,
"supersedes": 123,
"icon": "xyz789",
"ItemType": ItemType
}
}
}
createBatch
Description
Create a Batch
Response
Returns a Batch
Example
Query
mutation createBatch(
$name: String,
$recipeId: Int,
$formulationId: Int,
$batchSize: Float,
$cost: Float,
$notes: JSON,
$data: JSONObject,
$desiredMixingPercent: Float,
$isForSale: Boolean
) {
createBatch(
name: $name,
recipeId: $recipeId,
formulationId: $formulationId,
batchSize: $batchSize,
cost: $cost,
notes: $notes,
data: $data,
desiredMixingPercent: $desiredMixingPercent,
isForSale: $isForSale
) {
id
userId
recipeId
formulationId
createdAt
updatedAt
name
cost
batchSize
amountRemaining
version
lot
notes
data
desiredMixingPercent
isForSale
wasSold
Formulation {
...FormulationFragment
}
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{
"name": "abc123",
"recipeId": 987,
"formulationId": 987,
"batchSize": 987.65,
"cost": 987.65,
"notes": {},
"data": {},
"desiredMixingPercent": 987.65,
"isForSale": true
}
Response
{
"data": {
"createBatch": {
"id": 987,
"userId": 987,
"recipeId": 987,
"formulationId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"cost": 987.65,
"batchSize": 987.65,
"amountRemaining": 987.65,
"version": "abc123",
"lot": "abc123",
"notes": {},
"data": {},
"desiredMixingPercent": 987.65,
"isForSale": true,
"wasSold": true,
"Formulation": Formulation,
"Recipe": SimpleRecipe,
"User": User
}
}
}
createBatchRequest
Description
Create a Request to Purchase a Batch
Response
Returns a BatchRequest
Example
Query
mutation createBatchRequest(
$recipeId: Int,
$amountRequested: Float
) {
createBatchRequest(
recipeId: $recipeId,
amountRequested: $amountRequested
) {
id
userId
recipeId
createdAt
updatedAt
batchLot
amountRequested
isActive
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
Batch {
...SaleBatchFragment
}
}
}
Variables
{"recipeId": 987, "amountRequested": 123.45}
Response
{
"data": {
"createBatchRequest": {
"id": 987,
"userId": 987,
"recipeId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"batchLot": "xyz789",
"amountRequested": 987.65,
"isActive": false,
"Recipe": SimpleRecipe,
"User": User,
"Batch": SaleBatch
}
}
}
createDynamicPage
Description
Create a New Page
Response
Returns a DynamicPage
Arguments
| Name | Description |
|---|---|
title - String
|
|
slug - String
|
|
heading - String
|
|
content - JSONObject
|
|
folder - String
|
Example
Query
mutation createDynamicPage(
$title: String,
$slug: String,
$heading: String,
$content: JSONObject,
$folder: String
) {
createDynamicPage(
title: $title,
slug: $slug,
heading: $heading,
content: $content,
folder: $folder
) {
id
slug
title
createdAt
updatedAt
content
folder
heading
}
}
Variables
{
"title": "abc123",
"slug": "xyz789",
"heading": "xyz789",
"content": {},
"folder": "abc123"
}
Response
{
"data": {
"createDynamicPage": {
"id": 123,
"slug": "abc123",
"title": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"content": {},
"folder": "abc123",
"heading": "abc123"
}
}
}
createFavorite
Response
Returns a Favorite
Example
Query
mutation createFavorite(
$favoriteUserId: Int,
$flavorId: Int,
$formulationId: Int,
$recipeId: Int,
$shareKey: String,
$vendorId: Int
) {
createFavorite(
favoriteUserId: $favoriteUserId,
flavorId: $flavorId,
formulationId: $formulationId,
recipeId: $recipeId,
shareKey: $shareKey,
vendorId: $vendorId
) {
createdAt
}
}
Variables
{
"favoriteUserId": 987,
"flavorId": 123,
"formulationId": 987,
"recipeId": 123,
"shareKey": "abc123",
"vendorId": 987
}
Response
{
"data": {
"createFavorite": {
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
createFlavorList
Description
Create a Flavor List
Response
Returns a FlavorList
Example
Query
mutation createFlavorList(
$name: String,
$description: String,
$initialFlavorId: Int,
$isPublic: Boolean
) {
createFlavorList(
name: $name,
description: $description,
initialFlavorId: $initialFlavorId,
isPublic: $isPublic
) {
id
userId
createdAt
updatedAt
name
description
isPublic
ListFlavor {
...ListFlavorFragment
}
}
}
Variables
{
"name": "xyz789",
"description": "xyz789",
"initialFlavorId": 987,
"isPublic": false
}
Response
{
"data": {
"createFlavorList": {
"id": 123,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"description": "xyz789",
"isPublic": false,
"ListFlavor": [ListFlavor]
}
}
}
createFlavorNote
Description
Create a new Flavor Note
Response
Returns a FlavorNote
Example
Query
mutation createFlavorNote(
$flavorId: Int,
$shared: Boolean,
$steep: Int,
$score: Int,
$difficulty: Int,
$solo: Float,
$mix: Float,
$equipment: String,
$method: String,
$profile: String,
$pairing: String,
$notes: String
) {
createFlavorNote(
flavorId: $flavorId,
shared: $shared,
steep: $steep,
score: $score,
difficulty: $difficulty,
solo: $solo,
mix: $mix,
equipment: $equipment,
method: $method,
profile: $profile,
pairing: $pairing,
notes: $notes
) {
id
userId
flavorId
createdAt
updatedAt
notes
shared
steep
score
difficulty
ratingUp
ratingDown
solo
mix
equipment
method
profile
pairing
Flavor {
...FlavorFragment
}
User {
...UserFragment
}
Vendor {
...VendorFragment
}
}
}
Variables
{
"flavorId": 123,
"shared": false,
"steep": 987,
"score": 987,
"difficulty": 123,
"solo": 987.65,
"mix": 123.45,
"equipment": "abc123",
"method": "xyz789",
"profile": "abc123",
"pairing": "abc123",
"notes": "xyz789"
}
Response
{
"data": {
"createFlavorNote": {
"id": 123,
"userId": 123,
"flavorId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"notes": "abc123",
"shared": false,
"steep": 123,
"score": 123,
"difficulty": 123,
"ratingUp": 987,
"ratingDown": 987,
"solo": 123.45,
"mix": 123.45,
"equipment": "xyz789",
"method": "abc123",
"profile": "abc123",
"pairing": "abc123",
"Flavor": Flavor,
"User": User,
"Vendor": Vendor
}
}
}
createFolder
Description
Create a Recipe Folder
Response
Returns a Folder
Example
Query
mutation createFolder(
$name: String,
$description: String,
$initialRecipeId: Int,
$initialRecipeShareKey: String
) {
createFolder(
name: $name,
description: $description,
initialRecipeId: $initialRecipeId,
initialRecipeShareKey: $initialRecipeShareKey
) {
id
userId
createdAt
updatedAt
name
description
FolderRecipe {
...FolderRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{
"name": "abc123",
"description": "abc123",
"initialRecipeId": 987,
"initialRecipeShareKey": "abc123"
}
Response
{
"data": {
"createFolder": {
"id": 123,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"description": "xyz789",
"FolderRecipe": [FolderRecipe],
"User": User
}
}
}
createFolderRecipe
Response
Returns a FolderRecipeCreate
Example
Query
mutation createFolderRecipe(
$folderId: Int,
$recipeId: Int,
$shareKey: String
) {
createFolderRecipe(
folderId: $folderId,
recipeId: $recipeId,
shareKey: $shareKey
) {
folderId
recipeId
shareKey
createdAt
Folder {
...FolderFragment
}
Recipe {
...SimpleRecipeFragment
}
}
}
Variables
{
"folderId": 987,
"recipeId": 123,
"shareKey": "xyz789"
}
Response
{
"data": {
"createFolderRecipe": {
"folderId": 123,
"recipeId": 123,
"shareKey": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"Folder": Folder,
"Recipe": SimpleRecipe
}
}
}
createForumComment
Description
Create A Forum Comment
Response
Returns a ForumComment
Example
Query
mutation createForumComment(
$forumId: Int,
$topicId: Int,
$parentId: Int,
$bodyText: String,
$body: JSONObject,
$locked: Boolean
) {
createForumComment(
forumId: $forumId,
topicId: $topicId,
parentId: $parentId,
bodyText: $bodyText,
body: $body,
locked: $locked
) {
id
createdAt
updatedAt
rating
forumId
topicId
parentId
authorId
locked
ratingUp
ratingDown
threadPath
bodyText
body
meta
Forum {
...ForumFragment
}
ForumTopic {
...ForumTopicFragment
}
ForumComment {
...ParentCommentFragment
}
ForumComments {
...ChildCommentFragment
}
User {
...UserFragment
}
}
}
Variables
{
"forumId": 123,
"topicId": 987,
"parentId": 987,
"bodyText": "xyz789",
"body": {},
"locked": false
}
Response
{
"data": {
"createForumComment": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 123.45,
"forumId": 123,
"topicId": 123,
"parentId": 987,
"authorId": 987,
"locked": true,
"ratingUp": 987,
"ratingDown": 123,
"threadPath": "abc123",
"bodyText": "abc123",
"body": {},
"meta": {},
"Forum": Forum,
"ForumTopic": ForumTopic,
"ForumComment": ParentComment,
"ForumComments": ChildComment,
"User": User
}
}
}
createIngredient
Response
Returns an Ingredient
Example
Query
mutation createIngredient(
$active: Boolean,
$ingredientTypeId: Int,
$vendorId: Int,
$density: Float,
$code: String,
$name: String,
$slug: String,
$description: String,
$image: String,
$bases: JSON,
$discontinued: Boolean
) {
createIngredient(
active: $active,
ingredientTypeId: $ingredientTypeId,
vendorId: $vendorId,
density: $density,
code: $code,
name: $name,
slug: $slug,
description: $description,
image: $image,
bases: $bases,
discontinued: $discontinued
) {
id
active
ingredientTypeId
vendorId
density
code
createdAt
updatedAt
name
slug
description
image
discontinued
IngredientActive {
...IngredientActiveIngredientDefFragment
}
IngredientBase {
...IngredientBaseIngredientDefFragment
}
IngredientStash {
...IngredientStashFragment
}
IngredientType {
...IngredientTypeFragment
}
isStashed
stashes
Vendor {
...VendorFragment
}
IngredientTag {
...IngredientTagFragment
}
}
}
Variables
{
"active": false,
"ingredientTypeId": 987,
"vendorId": 123,
"density": 123.45,
"code": "xyz789",
"name": "xyz789",
"slug": "abc123",
"description": "xyz789",
"image": "xyz789",
"bases": {},
"discontinued": true
}
Response
{
"data": {
"createIngredient": {
"id": 987,
"active": false,
"ingredientTypeId": 123,
"vendorId": 123,
"density": 123.45,
"code": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"slug": "xyz789",
"description": "abc123",
"image": "abc123",
"discontinued": false,
"IngredientActive": [IngredientActiveIngredientDef],
"IngredientBase": [IngredientBaseIngredientDef],
"IngredientStash": IngredientStash,
"IngredientType": IngredientType,
"isStashed": false,
"stashes": 123,
"Vendor": Vendor,
"IngredientTag": [IngredientTag]
}
}
}
createIngredientType
Response
Returns an IngredientType
Example
Query
mutation createIngredientType {
createIngredientType {
id
name
slug
description
}
}
Response
{
"data": {
"createIngredientType": {
"id": 123,
"name": "xyz789",
"slug": "abc123",
"description": "xyz789"
}
}
}
createItemType
Example
Query
mutation createItemType(
$name: String,
$description: String
) {
createItemType(
name: $name,
description: $description
) {
id
name
slug
description
}
}
Variables
{
"name": "xyz789",
"description": "abc123"
}
Response
{
"data": {
"createItemType": {
"id": 123,
"name": "abc123",
"slug": "xyz789",
"description": "xyz789"
}
}
}
createListFlavor
Description
Add a Flavor to a Flavor List
Response
Returns a ListFlavor
Example
Query
mutation createListFlavor(
$flavorListId: Int,
$flavorId: Int
) {
createListFlavor(
flavorListId: $flavorListId,
flavorId: $flavorId
) {
flavorListId
flavorId
createdAt
FlavorList {
...FlavorListFragment
}
Flavor {
...FlavorFragment
}
}
}
Variables
{"flavorListId": 123, "flavorId": 987}
Response
{
"data": {
"createListFlavor": {
"flavorListId": 987,
"flavorId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"FlavorList": FlavorList,
"Flavor": Flavor
}
}
}
createRecipeComment
Description
Create A Recipe Comment
Response
Returns a RecipeComment
Example
Query
mutation createRecipeComment(
$recipeId: Int,
$parentId: Int,
$title: String,
$bodyText: String,
$body: JSONObject,
$locked: Boolean
) {
createRecipeComment(
recipeId: $recipeId,
parentId: $parentId,
title: $title,
bodyText: $bodyText,
body: $body,
locked: $locked
) {
id
recipeId
createdAt
updatedAt
title
rating
locked
parentId
authorId
ratingUp
ratingDown
threadPath
bodyText
body
meta
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{
"recipeId": 987,
"parentId": 123,
"title": "abc123",
"bodyText": "xyz789",
"body": {},
"locked": false
}
Response
{
"data": {
"createRecipeComment": {
"id": 987,
"recipeId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"rating": 987.65,
"locked": false,
"parentId": 123,
"authorId": 123,
"ratingUp": 123,
"ratingDown": 987,
"threadPath": "xyz789",
"bodyText": "abc123",
"body": {},
"meta": {},
"Recipe": SimpleRecipe,
"User": User
}
}
}
createRetailFlavor
Description
Create Retail Flavor
Response
Returns a Flavor
Example
Query
mutation createRetailFlavor(
$inStock: Boolean,
$active: Boolean,
$retailVendorId: Int,
$sellerId: Int,
$flavorId: Int,
$slug: String,
$clicks: Int,
$meta: JSONObject
) {
createRetailFlavor(
inStock: $inStock,
active: $active,
retailVendorId: $retailVendorId,
sellerId: $sellerId,
flavorId: $flavorId,
slug: $slug,
clicks: $clicks,
meta: $meta
) {
id
vendorId
density
createdAt
updatedAt
name
slug
rating
ratings
url
views
favorites
averageMillipercent
baseId
recipes
recMinMillipercent
recMaxMillipercent
vendorMillipercent
vendorUrl
discontinued
isFavorite
isStashed
FlavorStash {
...FlavorStashFragment
}
stashes
Vendor {
...VendorFragment
}
FlavorBase {
...IngredientFragment
}
RetailFlavor {
...RetailFlavorFragment
}
Sellers {
...RetailFlavorFragment
}
vendorPercent
flavorUsage
FlavorTag {
...FlavorTagFragment
}
}
}
Variables
{
"inStock": true,
"active": true,
"retailVendorId": 123,
"sellerId": 987,
"flavorId": 987,
"slug": "xyz789",
"clicks": 123,
"meta": {}
}
Response
{
"data": {
"createRetailFlavor": {
"id": 987,
"vendorId": 987,
"density": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"slug": "abc123",
"rating": 987.65,
"ratings": 987,
"url": "xyz789",
"views": 123,
"favorites": 987,
"averageMillipercent": 987,
"baseId": 987,
"recipes": 123,
"recMinMillipercent": 123,
"recMaxMillipercent": 987,
"vendorMillipercent": 123,
"vendorUrl": "abc123",
"discontinued": false,
"isFavorite": false,
"isStashed": true,
"FlavorStash": FlavorStash,
"stashes": 123,
"Vendor": Vendor,
"FlavorBase": Ingredient,
"RetailFlavor": RetailFlavor,
"Sellers": [RetailFlavor],
"vendorPercent": 123.45,
"flavorUsage": {},
"FlavorTag": [FlavorTag]
}
}
}
createRetailVendor
Description
Create Retail Vendor
Response
Returns a RetailVendor
Example
Query
mutation createRetailVendor(
$active: Boolean,
$sellerId: Int,
$vendorId: Int,
$slug: String,
$flavorUrlPattern: String,
$ingredientUrlPattern: String,
$meta: JSONObject
) {
createRetailVendor(
active: $active,
sellerId: $sellerId,
vendorId: $vendorId,
slug: $slug,
flavorUrlPattern: $flavorUrlPattern,
ingredientUrlPattern: $ingredientUrlPattern,
meta: $meta
) {
id
createdAt
updatedAt
vendorId
slug
active
sellerId
flavorUrlPattern
ingredientUrlPattern
clicks
meta
Flavor {
...FlavorFragment
}
Vendor_RetailVendor_sellerIdToVendor {
...VendorFragment
}
Vendor_RetailVendor_vendorIdToVendor {
...VendorFragment
}
}
}
Variables
{
"active": false,
"sellerId": 987,
"vendorId": 987,
"slug": "xyz789",
"flavorUrlPattern": "xyz789",
"ingredientUrlPattern": "xyz789",
"meta": {}
}
Response
{
"data": {
"createRetailVendor": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"vendorId": 123,
"slug": "xyz789",
"active": true,
"sellerId": 123,
"flavorUrlPattern": "xyz789",
"ingredientUrlPattern": "abc123",
"clicks": 987,
"meta": {},
"Flavor": Flavor,
"Vendor_RetailVendor_sellerIdToVendor": Vendor,
"Vendor_RetailVendor_vendorIdToVendor": Vendor
}
}
}
createReview
Description
Create a Review
Response
Returns a Review
Example
Query
mutation createReview(
$type: String,
$flavorId: Int,
$recipeId: Int,
$formulationId: Int,
$vendorId: Int,
$mixerId: Int,
$rating: Float,
$title: String,
$body: String
) {
createReview(
type: $type,
flavorId: $flavorId,
recipeId: $recipeId,
formulationId: $formulationId,
vendorId: $vendorId,
mixerId: $mixerId,
rating: $rating,
title: $title,
body: $body
) {
id
userId
rating
createdAt
updatedAt
title
body
User {
...UserFragment
}
}
}
Variables
{
"type": "abc123",
"flavorId": 123,
"recipeId": 123,
"formulationId": 987,
"vendorId": 987,
"mixerId": 123,
"rating": 123.45,
"title": "xyz789",
"body": "abc123"
}
Response
{
"data": {
"createReview": {
"id": 123,
"userId": 123,
"rating": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"body": "abc123",
"User": User
}
}
}
createRole
Example
Query
mutation createRole(
$name: String,
$description: String
) {
createRole(
name: $name,
description: $description
) {
id
name
description
}
}
Variables
{
"name": "xyz789",
"description": "xyz789"
}
Response
{
"data": {
"createRole": {
"id": 987,
"name": "abc123",
"description": "abc123"
}
}
}
createRolePermission
Description
Give a Role a Permission
Response
Returns a RolePermission
Example
Query
mutation createRolePermission(
$roleId: Int,
$permissionSubjectId: Int,
$permissionActionId: Int,
$inverted: Boolean,
$conditions: JSON,
$reason: String
) {
createRolePermission(
roleId: $roleId,
permissionSubjectId: $permissionSubjectId,
permissionActionId: $permissionActionId,
inverted: $inverted,
conditions: $conditions,
reason: $reason
) {
roleId
permissionSubjectId
permissionActionId
inverted
conditions
reason
ItemType {
...ItemTypeFragment
}
ItemAction {
...ItemActionFragment
}
Role {
...RoleFragment
}
}
}
Variables
{
"roleId": 987,
"permissionSubjectId": 123,
"permissionActionId": 987,
"inverted": false,
"conditions": {},
"reason": "abc123"
}
Response
{
"data": {
"createRolePermission": {
"roleId": 987,
"permissionSubjectId": 123,
"permissionActionId": 123,
"inverted": false,
"conditions": {},
"reason": "xyz789",
"ItemType": ItemType,
"ItemAction": ItemAction,
"Role": Role
}
}
}
createUpdateFlavorStash
Response
Returns a FlavorStash
Example
Query
mutation createUpdateFlavorStash(
$userId: Int,
$flavorId: Int,
$isStashed: Boolean,
$cost: Float,
$volume: Float,
$costPerML: Float,
$stockLevel: Float,
$location: String
) {
createUpdateFlavorStash(
userId: $userId,
flavorId: $flavorId,
isStashed: $isStashed,
cost: $cost,
volume: $volume,
costPerML: $costPerML,
stockLevel: $stockLevel,
location: $location
) {
userId
flavorId
isStashed
createdAt
updatedAt
recipes
stockLevel
cost
volume
costPerML
location
averageMillipercent
density
Flavor {
...FlavorFragment
}
User {
...UserFragment
}
}
}
Variables
{
"userId": 987,
"flavorId": 123,
"isStashed": true,
"cost": 123.45,
"volume": 987.65,
"costPerML": 123.45,
"stockLevel": 987.65,
"location": "abc123"
}
Response
{
"data": {
"createUpdateFlavorStash": {
"userId": 987,
"flavorId": 123,
"isStashed": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"recipes": 987,
"stockLevel": 987.65,
"cost": 987.65,
"volume": 123.45,
"costPerML": 987.65,
"location": "xyz789",
"averageMillipercent": 987,
"density": 987.65,
"Flavor": Flavor,
"User": User
}
}
}
createUpdateIngredientStash
Response
Returns an IngredientStash
Example
Query
mutation createUpdateIngredientStash(
$ingredientId: Int,
$isStashed: Boolean,
$cost: Float,
$volume: Float,
$costPerML: Float,
$stockLevel: Float,
$location: String,
$meta: JSONObject
) {
createUpdateIngredientStash(
ingredientId: $ingredientId,
isStashed: $isStashed,
cost: $cost,
volume: $volume,
costPerML: $costPerML,
stockLevel: $stockLevel,
location: $location,
meta: $meta
) {
userId
ingredientId
isStashed
createdAt
updatedAt
stockLevel
cost
volume
costPerML
location
meta
density
Ingredient {
...IngredientFragment
}
User {
...UserFragment
}
}
}
Variables
{
"ingredientId": 987,
"isStashed": true,
"cost": 987.65,
"volume": 987.65,
"costPerML": 123.45,
"stockLevel": 123.45,
"location": "xyz789",
"meta": {}
}
Response
{
"data": {
"createUpdateIngredientStash": {
"userId": 123,
"ingredientId": 123,
"isStashed": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"stockLevel": 123.45,
"cost": 123.45,
"volume": 987.65,
"costPerML": 987.65,
"location": "abc123",
"meta": {},
"density": 987,
"Ingredient": Ingredient,
"User": User
}
}
}
createUpdateUnconfirmedFlavor
Description
Create or Update a Flavor (Unconfirmed)
Response
Returns an UnconfirmedFlavor
Example
Query
mutation createUpdateUnconfirmedFlavor(
$id: Int,
$vendorId: Int,
$density: Float,
$vendorPercent: Float,
$vendorMillipercent: Int,
$baseId: Int,
$name: String,
$url: String
) {
createUpdateUnconfirmedFlavor(
id: $id,
vendorId: $vendorId,
density: $density,
vendorPercent: $vendorPercent,
vendorMillipercent: $vendorMillipercent,
baseId: $baseId,
name: $name,
url: $url
) {
id
vendorId
density
createdAt
name
url
userId
baseId
vendorMillipercent
Vendor {
...VendorFragment
}
vendorPercent
User {
...UserFragment
}
FlavorBase {
...IngredientFragment
}
}
}
Variables
{
"id": 987,
"vendorId": 987,
"density": 987.65,
"vendorPercent": 123.45,
"vendorMillipercent": 123,
"baseId": 987,
"name": "xyz789",
"url": "abc123"
}
Response
{
"data": {
"createUpdateUnconfirmedFlavor": {
"id": 987,
"vendorId": 123,
"density": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"url": "abc123",
"userId": 987,
"baseId": 123,
"vendorMillipercent": 987,
"Vendor": Vendor,
"vendorPercent": 123.45,
"User": User,
"FlavorBase": Ingredient
}
}
}
createUser
Description
User Registration | Create User
Response
Returns a User
Example
Query
mutation createUser(
$username: String,
$email: String,
$password: String,
$location: Int
) {
createUser(
username: $username,
email: $email,
password: $password,
location: $location
) {
id
username
image
createdAt
updatedAt
description
favorites
recipes
rating
ratings
publicRecipes
flavors
interests
location
restricted
isFavorite
imageThumb
imageUrl
isFollowing
isFollower
followers
publicInventory
showFollowers
showFollowing
Country {
...CountryFragment
}
UserBadge {
...BadgeAssignedToItemFragment
}
UserRole {
...UserRoleFragment
}
}
}
Variables
{
"username": "abc123",
"email": "xyz789",
"password": "xyz789",
"location": 123
}
Response
{
"data": {
"createUser": {
"id": 987,
"username": "abc123",
"image": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"favorites": 123,
"recipes": 987,
"rating": 123.45,
"ratings": 987,
"publicRecipes": 987,
"flavors": 987,
"interests": "xyz789",
"location": 987,
"restricted": true,
"isFavorite": true,
"imageThumb": "abc123",
"imageUrl": "abc123",
"isFollowing": false,
"isFollower": true,
"followers": 987,
"publicInventory": false,
"showFollowers": false,
"showFollowing": false,
"Country": Country,
"UserBadge": [BadgeAssignedToItem],
"UserRole": [UserRole]
}
}
}
createUserRole
Description
Create A User Role
Example
Query
mutation createUserRole(
$userId: Int,
$roleId: Int,
$active: Boolean
) {
createUserRole(
userId: $userId,
roleId: $roleId,
active: $active
) {
userId
active
roleId
Role {
...RoleFragment
}
User {
...UserFragment
}
}
}
Variables
{"userId": 987, "roleId": 123, "active": true}
Response
{
"data": {
"createUserRole": {
"userId": 987,
"active": false,
"roleId": 123,
"Role": Role,
"User": User
}
}
}
createVendor
Description
Create Vendor
Response
Returns a Vendor
Arguments
| Name | Description |
|---|---|
active - Boolean
|
|
vendorTypeId - Int
|
|
abbreviation - String
|
|
name - String
|
|
slug - String
|
|
location - Int
|
Country ID |
description - String
|
|
couponCode - String
|
|
referralUrl - String
|
|
referralParam - String
|
|
flavorUrlPattern - String
|
|
ingredientUrlPattern - String
|
|
file - Upload
|
|
websites - [VendorWebsiteInput]
|
Example
Query
mutation createVendor(
$active: Boolean,
$vendorTypeId: Int,
$abbreviation: String,
$name: String,
$slug: String,
$location: Int,
$description: String,
$couponCode: String,
$referralUrl: String,
$referralParam: String,
$flavorUrlPattern: String,
$ingredientUrlPattern: String,
$file: Upload,
$websites: [VendorWebsiteInput]
) {
createVendor(
active: $active,
vendorTypeId: $vendorTypeId,
abbreviation: $abbreviation,
name: $name,
slug: $slug,
location: $location,
description: $description,
couponCode: $couponCode,
referralUrl: $referralUrl,
referralParam: $referralParam,
flavorUrlPattern: $flavorUrlPattern,
ingredientUrlPattern: $ingredientUrlPattern,
file: $file,
websites: $websites
) {
id
createdAt
updatedAt
name
description
favorites
rating
ratings
recipes
image
slug
active
abbreviation
vendorTypeId
location
couponCode
referralUrl
referralParam
flavorUrlPattern
ingredientUrlPattern
isFavorite
imageThumb
imageUrl
Country {
...CountryFragment
}
VendorBadge {
...BadgeAssignedToItemFragment
}
VendorType {
...VendorTypeFragment
}
VendorWebsite {
...VendorWebsiteFragment
}
}
}
Variables
{
"active": true,
"vendorTypeId": 123,
"abbreviation": "xyz789",
"name": "abc123",
"slug": "xyz789",
"location": 987,
"description": "abc123",
"couponCode": "abc123",
"referralUrl": "xyz789",
"referralParam": "xyz789",
"flavorUrlPattern": "xyz789",
"ingredientUrlPattern": "xyz789",
"file": Upload,
"websites": [VendorWebsiteInput]
}
Response
{
"data": {
"createVendor": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"description": "abc123",
"favorites": 123,
"rating": 987.65,
"ratings": 123,
"recipes": 987,
"image": "abc123",
"slug": "abc123",
"active": false,
"abbreviation": "xyz789",
"vendorTypeId": 987,
"location": 987,
"couponCode": "abc123",
"referralUrl": "abc123",
"referralParam": "xyz789",
"flavorUrlPattern": "abc123",
"ingredientUrlPattern": "xyz789",
"isFavorite": true,
"imageThumb": "xyz789",
"imageUrl": "xyz789",
"Country": Country,
"VendorBadge": [BadgeAssignedToItem],
"VendorType": VendorType,
"VendorWebsite": [VendorWebsite]
}
}
}
createVendorType
Description
Create Vendor Type
Response
Returns a VendorType
Example
Query
mutation createVendorType(
$name: String,
$slug: String,
$description: String
) {
createVendorType(
name: $name,
slug: $slug,
description: $description
) {
id
name
slug
description
}
}
Variables
{
"name": "abc123",
"slug": "abc123",
"description": "abc123"
}
Response
{
"data": {
"createVendorType": {
"id": 123,
"name": "xyz789",
"slug": "abc123",
"description": "xyz789"
}
}
}
deleteRecipe
Description
Delete a Recipe, without Permanently Removing it
Response
Returns a DeleteRecipe
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation deleteRecipe($id: Int) {
deleteRecipe(id: $id) {
id
isPublished
userId
createdAt
deletedAt
updatedAt
rating
ratings
name
image
shareKey
slug
description
favorites
steepDays
color
isShared
isOriginal
isInProgress
isMTL
isSNV
licenseId
revisions
adaptedId
flavors
mixes
notes
publishedAt
restricted
restrictedAt
restrictedReason
totalMillipercent
views
comments
}
}
Variables
{"id": 123}
Response
{
"data": {
"deleteRecipe": {
"id": 987,
"isPublished": false,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"ratings": 123,
"name": "abc123",
"image": "xyz789",
"shareKey": "xyz789",
"slug": "abc123",
"description": "xyz789",
"favorites": 123,
"steepDays": 987,
"color": "xyz789",
"isShared": false,
"isOriginal": false,
"isInProgress": true,
"isMTL": false,
"isSNV": false,
"licenseId": 123,
"revisions": 123,
"adaptedId": 987,
"flavors": 123,
"mixes": 987,
"notes": {},
"publishedAt": "2007-12-03T10:15:30Z",
"restricted": true,
"restrictedAt": "2007-12-03T10:15:30Z",
"restrictedReason": "xyz789",
"totalMillipercent": 123.45,
"views": 987,
"comments": 123
}
}
}
downVoteFlavorNote
Response
Returns a FlavorNote
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation downVoteFlavorNote($id: Int) {
downVoteFlavorNote(id: $id) {
id
userId
flavorId
createdAt
updatedAt
notes
shared
steep
score
difficulty
ratingUp
ratingDown
solo
mix
equipment
method
profile
pairing
Flavor {
...FlavorFragment
}
User {
...UserFragment
}
Vendor {
...VendorFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"downVoteFlavorNote": {
"id": 123,
"userId": 123,
"flavorId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"notes": "abc123",
"shared": true,
"steep": 123,
"score": 987,
"difficulty": 123,
"ratingUp": 987,
"ratingDown": 123,
"solo": 123.45,
"mix": 123.45,
"equipment": "xyz789",
"method": "abc123",
"profile": "xyz789",
"pairing": "abc123",
"Flavor": Flavor,
"User": User,
"Vendor": Vendor
}
}
}
follow
Example
Query
mutation follow($followUserId: Int) {
follow(followUserId: $followUserId) {
followUserId
userId
createdAt
User {
...UserFragment
}
}
}
Variables
{"followUserId": 123}
Response
{
"data": {
"follow": {
"followUserId": 123,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"User": User
}
}
}
formulation
Description
Create or Update a Formulation Definition
Response
Returns a Formulation
Arguments
| Name | Description |
|---|---|
id - Int
|
|
adaptedId - Int
|
|
description - String
|
|
flavorMultiplier - Float
|
|
isPublished - Boolean
|
|
isOriginal - Boolean
|
|
name - String
|
|
formulationIngredients - [FormulationIngredientList]
|
|
relationship - RecipeFormulationInput
|
Example
Query
mutation formulation(
$id: Int,
$adaptedId: Int,
$description: String,
$flavorMultiplier: Float,
$isPublished: Boolean,
$isOriginal: Boolean,
$name: String,
$formulationIngredients: [FormulationIngredientList],
$relationship: RecipeFormulationInput
) {
formulation(
id: $id,
adaptedId: $adaptedId,
description: $description,
flavorMultiplier: $flavorMultiplier,
isPublished: $isPublished,
isOriginal: $isOriginal,
name: $name,
formulationIngredients: $formulationIngredients,
relationship: $relationship
) {
id
name
userId
createdAt
updatedAt
isPublished
description
favorites
mixes
flavorMultiplier
isOriginal
adaptedId
communityDefault
isFavorite
recommendedBy
recipes
recipeUserId
RecipeFormulation {
...RecipeFormulationFragment
}
relationship {
...SimpleRecipeFormulationFragment
}
FormulationIngredient {
...FormulationIngredientFragment
}
User {
...UserFragment
}
AdaptedFormulation {
...AdaptedFormulationFragment
}
FormulationTag {
...FormulationTagFragment
}
}
}
Variables
{
"id": 123,
"adaptedId": 123,
"description": "abc123",
"flavorMultiplier": 123.45,
"isPublished": true,
"isOriginal": false,
"name": "abc123",
"formulationIngredients": [FormulationIngredientList],
"relationship": RecipeFormulationInput
}
Response
{
"data": {
"formulation": {
"id": 987,
"name": "abc123",
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"isPublished": true,
"description": "xyz789",
"favorites": 987,
"mixes": 987,
"flavorMultiplier": 123.45,
"isOriginal": false,
"adaptedId": 987,
"communityDefault": true,
"isFavorite": false,
"recommendedBy": {},
"recipes": 123,
"recipeUserId": 123,
"RecipeFormulation": [RecipeFormulation],
"relationship": SimpleRecipeFormulation,
"FormulationIngredient": [FormulationIngredient],
"User": User,
"AdaptedFormulation": AdaptedFormulation,
"FormulationTag": [FormulationTag]
}
}
}
forum
Description
Update A Forum
Response
Returns a Forum
Example
Query
mutation forum(
$id: Int,
$parentId: Int,
$allowTopics: Boolean,
$locked: Boolean,
$title: String,
$slug: String,
$description: String,
$dataSchema: String
) {
forum(
id: $id,
parentId: $parentId,
allowTopics: $allowTopics,
locked: $locked,
title: $title,
slug: $slug,
description: $description,
dataSchema: $dataSchema
) {
id
userId
createdAt
updatedAt
title
slug
description
image
parentId
allowTopics
externalData
locked
topics
comments
itemTypeId
lastActivityAt
rating
ratingUp
ratingDown
dataSchema
meta
Forum {
...ParentForumFragment
}
Forums {
...ChildForumFragment
}
}
}
Variables
{
"id": 987,
"parentId": 987,
"allowTopics": true,
"locked": true,
"title": "abc123",
"slug": "abc123",
"description": "abc123",
"dataSchema": "abc123"
}
Response
{
"data": {
"forum": {
"id": 123,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"slug": "abc123",
"description": "xyz789",
"image": "xyz789",
"parentId": 987,
"allowTopics": true,
"externalData": true,
"locked": true,
"topics": 987,
"comments": 987,
"itemTypeId": 123,
"lastActivityAt": "2007-12-03T10:15:30Z",
"rating": 987,
"ratingUp": 987,
"ratingDown": 123,
"dataSchema": "xyz789",
"meta": {},
"Forum": ParentForum,
"Forums": [ChildForum]
}
}
}
forumCommentRate
Description
Rate a Forum Comment
Response
Returns a ForumComment
Example
Query
mutation forumCommentRate(
$id: Int,
$rateUp: Boolean,
$rateDown: Boolean
) {
forumCommentRate(
id: $id,
rateUp: $rateUp,
rateDown: $rateDown
) {
id
createdAt
updatedAt
rating
forumId
topicId
parentId
authorId
locked
ratingUp
ratingDown
threadPath
bodyText
body
meta
Forum {
...ForumFragment
}
ForumTopic {
...ForumTopicFragment
}
ForumComment {
...ParentCommentFragment
}
ForumComments {
...ChildCommentFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 987, "rateUp": false, "rateDown": true}
Response
{
"data": {
"forumCommentRate": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 123.45,
"forumId": 123,
"topicId": 123,
"parentId": 987,
"authorId": 987,
"locked": false,
"ratingUp": 987,
"ratingDown": 123,
"threadPath": "abc123",
"bodyText": "abc123",
"body": {},
"meta": {},
"Forum": Forum,
"ForumTopic": ForumTopic,
"ForumComment": ParentComment,
"ForumComments": ChildComment,
"User": User
}
}
}
forumTopic
Description
Update A Forum Topic
Response
Returns a ForumTopic
Example
Query
mutation forumTopic(
$id: Int,
$forumId: Int,
$locked: Boolean,
$pinned: Boolean,
$title: String,
$bodyText: String,
$body: JSONObject
) {
forumTopic(
id: $id,
forumId: $forumId,
locked: $locked,
pinned: $pinned,
title: $title,
bodyText: $bodyText,
body: $body
) {
id
createdAt
updatedAt
title
slug
forumId
authorId
locked
pinned
comments
views
rating
ratingUp
ratingDown
bodyText
body
lastActivityAt
meta
Forum {
...ForumFragment
}
ForumComment {
...ForumCommentFragment
}
User {
...UserFragment
}
}
}
Variables
{
"id": 123,
"forumId": 987,
"locked": false,
"pinned": true,
"title": "abc123",
"bodyText": "abc123",
"body": {}
}
Response
{
"data": {
"forumTopic": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"slug": "abc123",
"forumId": 987,
"authorId": 987,
"locked": true,
"pinned": false,
"comments": 123,
"views": 123,
"rating": 987,
"ratingUp": 123,
"ratingDown": 987,
"bodyText": "abc123",
"body": {},
"lastActivityAt": "2007-12-03T10:15:30Z",
"meta": {},
"Forum": Forum,
"ForumComment": ForumComment,
"User": User
}
}
}
forumTopicPin
Description
Pin or Unpin a Forum Topic
Response
Returns a ForumTopic
Example
Query
mutation forumTopicPin(
$id: Int,
$pinned: Boolean
) {
forumTopicPin(
id: $id,
pinned: $pinned
) {
id
createdAt
updatedAt
title
slug
forumId
authorId
locked
pinned
comments
views
rating
ratingUp
ratingDown
bodyText
body
lastActivityAt
meta
Forum {
...ForumFragment
}
ForumComment {
...ForumCommentFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 987, "pinned": true}
Response
{
"data": {
"forumTopicPin": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"slug": "abc123",
"forumId": 987,
"authorId": 987,
"locked": true,
"pinned": false,
"comments": 123,
"views": 123,
"rating": 987,
"ratingUp": 123,
"ratingDown": 123,
"bodyText": "xyz789",
"body": {},
"lastActivityAt": "2007-12-03T10:15:30Z",
"meta": {},
"Forum": Forum,
"ForumComment": ForumComment,
"User": User
}
}
}
forumTopicRate
Description
Rate a Forum Topic
Response
Returns a ForumTopic
Example
Query
mutation forumTopicRate(
$id: Int,
$rateUp: Boolean,
$rateDown: Boolean
) {
forumTopicRate(
id: $id,
rateUp: $rateUp,
rateDown: $rateDown
) {
id
createdAt
updatedAt
title
slug
forumId
authorId
locked
pinned
comments
views
rating
ratingUp
ratingDown
bodyText
body
lastActivityAt
meta
Forum {
...ForumFragment
}
ForumComment {
...ForumCommentFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 987, "rateUp": true, "rateDown": false}
Response
{
"data": {
"forumTopicRate": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"slug": "abc123",
"forumId": 987,
"authorId": 987,
"locked": true,
"pinned": false,
"comments": 987,
"views": 123,
"rating": 987,
"ratingUp": 123,
"ratingDown": 123,
"bodyText": "xyz789",
"body": {},
"lastActivityAt": "2007-12-03T10:15:30Z",
"meta": {},
"Forum": Forum,
"ForumComment": ForumComment,
"User": User
}
}
}
loginUser
Description
User Login
Response
Returns a LoginResult
Example
Query
mutation loginUser(
$email: String,
$username: String,
$password: String
) {
loginUser(
email: $email,
username: $username,
password: $password
) {
... on LoginUser {
...LoginUserFragment
}
... on BaseError {
...BaseErrorFragment
}
}
}
Variables
{
"email": "abc123",
"username": "abc123",
"password": "xyz789"
}
Response
{"data": {"loginUser": LoginUser}}
logoutUser
Description
User Logout
Response
Returns a LoginUser
Example
Query
mutation logoutUser {
logoutUser {
id
username
createdAt
updatedAt
email
banned
bannedAt
bannedEnd
bannedReason
bannedByUserId
confirmedAt
currentLoginDate
logins
prevLoginDate
resetAt
token
session
}
}
Response
{
"data": {
"logoutUser": {
"id": 987,
"username": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "xyz789",
"banned": false,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "xyz789",
"bannedByUserId": 123,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 987,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z",
"token": "xyz789",
"session": "abc123"
}
}
}
masterTag
Description
Create or Update a Tag
Response
Returns a Tag
Example
Query
mutation masterTag(
$id: Int,
$parentId: Int,
$aliasId: Int,
$active: Boolean,
$confirmed: Boolean,
$name: String,
$tier: Int,
$meta: JSONObject
) {
masterTag(
id: $id,
parentId: $parentId,
aliasId: $aliasId,
active: $active,
confirmed: $confirmed,
name: $name,
tier: $tier,
meta: $meta
) {
id
parentId
active
name
createdAt
updatedAt
confirmed
aliasId
tier
path
meta
childDepth
Alias {
...TagBaseFragment
}
FlavorTag {
...FlavorTagFragment
}
FormulationTag {
...FormulationTagFragment
}
IngredientTag {
...IngredientTagFragment
}
Parent {
...TagBaseFragment
}
RecipeTag {
...RecipeTagFragment
}
Tags {
...TagBaseFragment
}
}
}
Variables
{
"id": 987,
"parentId": 123,
"aliasId": 123,
"active": false,
"confirmed": false,
"name": "abc123",
"tier": 987,
"meta": {}
}
Response
{
"data": {
"masterTag": {
"id": 987,
"parentId": 123,
"active": false,
"name": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"confirmed": false,
"aliasId": 123,
"tier": 123,
"path": "abc123",
"meta": {},
"childDepth": 987,
"Alias": TagBase,
"FlavorTag": FlavorTag,
"FormulationTag": FormulationTag,
"IngredientTag": IngredientTag,
"Parent": TagBase,
"RecipeTag": RecipeTag,
"Tags": [TagBase]
}
}
}
rateTag
Description
Rate an assigned Tag
Response
Returns a TagType
Example
Query
mutation rateTag(
$tagId: Int,
$flavorId: Int,
$formulationId: Int,
$ingredientId: Int,
$recipeId: Int,
$rateUp: Boolean,
$rateDown: Boolean
) {
rateTag(
tagId: $tagId,
flavorId: $flavorId,
formulationId: $formulationId,
ingredientId: $ingredientId,
recipeId: $recipeId,
rateUp: $rateUp,
rateDown: $rateDown
) {
active
tagId
createdAt
updatedAt
userId
weight
rating
meta
}
}
Variables
{
"tagId": 123,
"flavorId": 987,
"formulationId": 987,
"ingredientId": 987,
"recipeId": 987,
"rateUp": true,
"rateDown": false
}
Response
{
"data": {
"rateTag": {
"active": true,
"tagId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"userId": 987,
"weight": 987,
"rating": 123,
"meta": {}
}
}
}
recipe
Description
Create or Update a Recipe
Response
Returns a Recipe
Arguments
| Name | Description |
|---|---|
id - Int
|
|
isPublished - Boolean
|
|
isShared - Boolean
|
|
isInProgress - Boolean
|
|
isOriginal - Boolean
|
|
licenseId - Int
|
|
adaptedId - Int
|
|
name - String
|
|
color - String
|
|
description - String
|
|
notes - String
|
|
image - String
|
|
slug - String
|
|
file - Upload
|
|
flavors - [RecipeFlavorList]
|
|
restricted - Boolean
|
|
restrictedReason - String
|
|
steepDays - Int
|
Example
Query
mutation recipe(
$id: Int,
$isPublished: Boolean,
$isShared: Boolean,
$isInProgress: Boolean,
$isOriginal: Boolean,
$licenseId: Int,
$adaptedId: Int,
$name: String,
$color: String,
$description: String,
$notes: String,
$image: String,
$slug: String,
$file: Upload,
$flavors: [RecipeFlavorList],
$restricted: Boolean,
$restrictedReason: String,
$steepDays: Int
) {
recipe(
id: $id,
isPublished: $isPublished,
isShared: $isShared,
isInProgress: $isInProgress,
isOriginal: $isOriginal,
licenseId: $licenseId,
adaptedId: $adaptedId,
name: $name,
color: $color,
description: $description,
notes: $notes,
image: $image,
slug: $slug,
file: $file,
flavors: $flavors,
restricted: $restricted,
restrictedReason: $restrictedReason,
steepDays: $steepDays
) {
id
isPublished
userId
createdAt
deletedAt
updatedAt
rating
ratings
name
image
shareKey
slug
description
favorites
steepDays
color
isShared
isOriginal
isInProgress
isMTL
isSNV
licenseId
revisions
adaptedId
flavors
mixes
notes
publishedAt
restricted
restrictedAt
restrictedReason
totalMillipercent
views
comments
imageUrl
imageThumb
isFavorite
recipeShare
flavorCount
totalPercent
License {
...LicenseFragment
}
RecipeBadge {
...BadgeAssignedToItemFragment
}
RecipeFlavor {
...RecipeFlavorFragment
}
User {
...UserFragment
}
AdaptedRecipe {
...SimpleRecipeFragment
}
RecipeTag {
...RecipeTagFragment
}
}
}
Variables
{
"id": 123,
"isPublished": false,
"isShared": true,
"isInProgress": true,
"isOriginal": false,
"licenseId": 123,
"adaptedId": 987,
"name": "abc123",
"color": "abc123",
"description": "abc123",
"notes": "xyz789",
"image": "abc123",
"slug": "abc123",
"file": Upload,
"flavors": [RecipeFlavorList],
"restricted": false,
"restrictedReason": "abc123",
"steepDays": 987
}
Response
{
"data": {
"recipe": {
"id": 987,
"isPublished": false,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"ratings": 123,
"name": "abc123",
"image": "xyz789",
"shareKey": "abc123",
"slug": "abc123",
"description": "xyz789",
"favorites": 123,
"steepDays": 123,
"color": "abc123",
"isShared": true,
"isOriginal": true,
"isInProgress": false,
"isMTL": false,
"isSNV": false,
"licenseId": 987,
"revisions": 123,
"adaptedId": 987,
"flavors": 123,
"mixes": 123,
"notes": {},
"publishedAt": "2007-12-03T10:15:30Z",
"restricted": true,
"restrictedAt": "2007-12-03T10:15:30Z",
"restrictedReason": "abc123",
"totalMillipercent": 123.45,
"views": 987,
"comments": 987,
"imageUrl": "xyz789",
"imageThumb": "abc123",
"isFavorite": true,
"recipeShare": {},
"flavorCount": 987,
"totalPercent": 987.65,
"License": License,
"RecipeBadge": [BadgeAssignedToItem],
"RecipeFlavor": [RecipeFlavor],
"User": User,
"AdaptedRecipe": SimpleRecipe,
"RecipeTag": [RecipeTag]
}
}
}
recipeCommentRate
Description
Rate a Recipe Comment
Response
Returns a RecipeComment
Example
Query
mutation recipeCommentRate(
$id: Int,
$rateUp: Boolean,
$rateDown: Boolean
) {
recipeCommentRate(
id: $id,
rateUp: $rateUp,
rateDown: $rateDown
) {
id
recipeId
createdAt
updatedAt
title
rating
locked
parentId
authorId
ratingUp
ratingDown
threadPath
bodyText
body
meta
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 123, "rateUp": false, "rateDown": false}
Response
{
"data": {
"recipeCommentRate": {
"id": 123,
"recipeId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"rating": 123.45,
"locked": true,
"parentId": 123,
"authorId": 987,
"ratingUp": 123,
"ratingDown": 123,
"threadPath": "abc123",
"bodyText": "xyz789",
"body": {},
"meta": {},
"Recipe": SimpleRecipe,
"User": User
}
}
}
recipeFormulation
Description
Create or Update Recipe Formulation
Response
Returns a SimpleRecipeFormulation
Example
Query
mutation recipeFormulation(
$recipeId: Int,
$formulationId: Int
) {
recipeFormulation(
recipeId: $recipeId,
formulationId: $formulationId
) {
recipeId
formulationId
createdAt
updatedAt
recCount
recUsers
}
}
Variables
{"recipeId": 987, "formulationId": 123}
Response
{
"data": {
"recipeFormulation": {
"recipeId": 987,
"formulationId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"recCount": 123,
"recUsers": {}
}
}
}
rejectFlavor
Description
Reject an Unconfirmed Flavor
Response
Returns an UnconfirmedFlavor
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation rejectFlavor($id: Int) {
rejectFlavor(id: $id) {
id
vendorId
density
createdAt
name
url
userId
baseId
vendorMillipercent
Vendor {
...VendorFragment
}
vendorPercent
User {
...UserFragment
}
FlavorBase {
...IngredientFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"rejectFlavor": {
"id": 123,
"vendorId": 123,
"density": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"url": "abc123",
"userId": 987,
"baseId": 123,
"vendorMillipercent": 987,
"Vendor": Vendor,
"vendorPercent": 123.45,
"User": User,
"FlavorBase": Ingredient
}
}
}
removeBadge
Description
Permanently Remove a Badge
Example
Query
mutation removeBadge($id: Int) {
removeBadge(id: $id) {
id
createdAt
updatedAt
name
image
description
itemTypeId
supersedes
icon
ItemType {
...ItemTypeFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeBadge": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"image": "abc123",
"description": "abc123",
"itemTypeId": 123,
"supersedes": 987,
"icon": "abc123",
"ItemType": ItemType
}
}
}
removeBatch
Description
Permanently Remove a Batch
Example
Query
mutation removeBatch($id: Int) {
removeBatch(id: $id) {
id
userId
recipeId
formulationId
createdAt
updatedAt
name
cost
batchSize
amountRemaining
version
lot
notes
data
desiredMixingPercent
isForSale
wasSold
Formulation {
...FormulationFragment
}
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeBatch": {
"id": 987,
"userId": 123,
"recipeId": 123,
"formulationId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"cost": 987.65,
"batchSize": 123.45,
"amountRemaining": 123.45,
"version": "xyz789",
"lot": "xyz789",
"notes": {},
"data": {},
"desiredMixingPercent": 123.45,
"isForSale": true,
"wasSold": false,
"Formulation": Formulation,
"Recipe": SimpleRecipe,
"User": User
}
}
}
removeBatchRequest
Description
Permanently Remove a Batch
Response
Returns a BatchRequest
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeBatchRequest($id: Int) {
removeBatchRequest(id: $id) {
id
userId
recipeId
createdAt
updatedAt
batchLot
amountRequested
isActive
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
Batch {
...SaleBatchFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"removeBatchRequest": {
"id": 123,
"userId": 123,
"recipeId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"batchLot": "abc123",
"amountRequested": 987.65,
"isActive": false,
"Recipe": SimpleRecipe,
"User": User,
"Batch": SaleBatch
}
}
}
removeDynamicPage
Description
Permanently Remove a Dynamic Page
Response
Returns a DynamicPage
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeDynamicPage($id: Int) {
removeDynamicPage(id: $id) {
id
slug
title
createdAt
updatedAt
content
folder
heading
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeDynamicPage": {
"id": 987,
"slug": "xyz789",
"title": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"content": {},
"folder": "xyz789",
"heading": "abc123"
}
}
}
removeFavorite
Response
Returns a Favorite
Example
Query
mutation removeFavorite(
$favoriteUserId: Int,
$flavorId: Int,
$formulationId: Int,
$recipeId: Int,
$vendorId: Int
) {
removeFavorite(
favoriteUserId: $favoriteUserId,
flavorId: $flavorId,
formulationId: $formulationId,
recipeId: $recipeId,
vendorId: $vendorId
) {
createdAt
}
}
Variables
{
"favoriteUserId": 123,
"flavorId": 987,
"formulationId": 987,
"recipeId": 123,
"vendorId": 123
}
Response
{
"data": {
"removeFavorite": {
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
removeFlavor
Description
Permanently Remove a Flavor
Example
Query
mutation removeFlavor($id: Int) {
removeFlavor(id: $id) {
id
vendorId
density
createdAt
updatedAt
name
slug
rating
ratings
url
views
favorites
averageMillipercent
baseId
recipes
recMinMillipercent
recMaxMillipercent
vendorMillipercent
vendorUrl
discontinued
isFavorite
isStashed
FlavorStash {
...FlavorStashFragment
}
stashes
Vendor {
...VendorFragment
}
FlavorBase {
...IngredientFragment
}
RetailFlavor {
...RetailFlavorFragment
}
Sellers {
...RetailFlavorFragment
}
vendorPercent
flavorUsage
FlavorTag {
...FlavorTagFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"removeFlavor": {
"id": 987,
"vendorId": 987,
"density": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"slug": "abc123",
"rating": 123.45,
"ratings": 987,
"url": "abc123",
"views": 123,
"favorites": 123,
"averageMillipercent": 123,
"baseId": 987,
"recipes": 987,
"recMinMillipercent": 987,
"recMaxMillipercent": 123,
"vendorMillipercent": 987,
"vendorUrl": "abc123",
"discontinued": true,
"isFavorite": true,
"isStashed": false,
"FlavorStash": FlavorStash,
"stashes": 987,
"Vendor": Vendor,
"FlavorBase": Ingredient,
"RetailFlavor": RetailFlavor,
"Sellers": [RetailFlavor],
"vendorPercent": 123.45,
"flavorUsage": {},
"FlavorTag": [FlavorTag]
}
}
}
removeFlavorList
Description
Permanently Remove a Flavor List
Response
Returns a FlavorList
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeFlavorList($id: Int) {
removeFlavorList(id: $id) {
id
userId
createdAt
updatedAt
name
description
isPublic
ListFlavor {
...ListFlavorFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeFlavorList": {
"id": 123,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"description": "abc123",
"isPublic": true,
"ListFlavor": [ListFlavor]
}
}
}
removeFlavorNote
Description
Remove a Flavor Note
Response
Returns a FlavorNote
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeFlavorNote($id: Int) {
removeFlavorNote(id: $id) {
id
userId
flavorId
createdAt
updatedAt
notes
shared
steep
score
difficulty
ratingUp
ratingDown
solo
mix
equipment
method
profile
pairing
Flavor {
...FlavorFragment
}
User {
...UserFragment
}
Vendor {
...VendorFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"removeFlavorNote": {
"id": 987,
"userId": 987,
"flavorId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"notes": "abc123",
"shared": true,
"steep": 123,
"score": 987,
"difficulty": 123,
"ratingUp": 123,
"ratingDown": 987,
"solo": 987.65,
"mix": 987.65,
"equipment": "xyz789",
"method": "abc123",
"profile": "xyz789",
"pairing": "xyz789",
"Flavor": Flavor,
"User": User,
"Vendor": Vendor
}
}
}
removeFlavorStash
Response
Returns a FlavorStash
Example
Query
mutation removeFlavorStash(
$userId: Int,
$flavorId: Int
) {
removeFlavorStash(
userId: $userId,
flavorId: $flavorId
) {
userId
flavorId
isStashed
createdAt
updatedAt
recipes
stockLevel
cost
volume
costPerML
location
averageMillipercent
density
Flavor {
...FlavorFragment
}
User {
...UserFragment
}
}
}
Variables
{"userId": 987, "flavorId": 987}
Response
{
"data": {
"removeFlavorStash": {
"userId": 987,
"flavorId": 123,
"isStashed": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"recipes": 987,
"stockLevel": 987.65,
"cost": 987.65,
"volume": 987.65,
"costPerML": 123.45,
"location": "xyz789",
"averageMillipercent": 123,
"density": 987.65,
"Flavor": Flavor,
"User": User
}
}
}
removeFolder
Example
Query
mutation removeFolder($id: Int) {
removeFolder(id: $id) {
id
userId
createdAt
updatedAt
name
description
FolderRecipe {
...FolderRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"removeFolder": {
"id": 123,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"description": "abc123",
"FolderRecipe": [FolderRecipe],
"User": User
}
}
}
removeFolderRecipe
Response
Returns a FolderRecipeRemove
Example
Query
mutation removeFolderRecipe(
$folderId: Int,
$recipeId: Int
) {
removeFolderRecipe(
folderId: $folderId,
recipeId: $recipeId
) {
folderId
recipeId
shareKey
createdAt
Folder {
...FolderFragment
}
Recipe {
...SimpleRecipeFragment
}
}
}
Variables
{"folderId": 987, "recipeId": 987}
Response
{
"data": {
"removeFolderRecipe": {
"folderId": 987,
"recipeId": 987,
"shareKey": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"Folder": Folder,
"Recipe": SimpleRecipe
}
}
}
removeFormulation
Description
Permanently Remove a Formulation
Response
Returns a Formulation
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeFormulation($id: Int) {
removeFormulation(id: $id) {
id
name
userId
createdAt
updatedAt
isPublished
description
favorites
mixes
flavorMultiplier
isOriginal
adaptedId
communityDefault
isFavorite
recommendedBy
recipes
recipeUserId
RecipeFormulation {
...RecipeFormulationFragment
}
relationship {
...SimpleRecipeFormulationFragment
}
FormulationIngredient {
...FormulationIngredientFragment
}
User {
...UserFragment
}
AdaptedFormulation {
...AdaptedFormulationFragment
}
FormulationTag {
...FormulationTagFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeFormulation": {
"id": 123,
"name": "xyz789",
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"isPublished": false,
"description": "xyz789",
"favorites": 123,
"mixes": 987,
"flavorMultiplier": 987.65,
"isOriginal": false,
"adaptedId": 123,
"communityDefault": false,
"isFavorite": false,
"recommendedBy": {},
"recipes": 987,
"recipeUserId": 123,
"RecipeFormulation": [RecipeFormulation],
"relationship": SimpleRecipeFormulation,
"FormulationIngredient": [FormulationIngredient],
"User": User,
"AdaptedFormulation": AdaptedFormulation,
"FormulationTag": [FormulationTag]
}
}
}
removeForum
Description
Permanently Remove a Forum
Example
Query
mutation removeForum($id: Int) {
removeForum(id: $id) {
id
userId
createdAt
updatedAt
title
slug
description
image
parentId
allowTopics
externalData
locked
topics
comments
itemTypeId
lastActivityAt
rating
ratingUp
ratingDown
dataSchema
meta
Forum {
...ParentForumFragment
}
Forums {
...ChildForumFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"removeForum": {
"id": 123,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"slug": "abc123",
"description": "xyz789",
"image": "abc123",
"parentId": 123,
"allowTopics": true,
"externalData": false,
"locked": true,
"topics": 123,
"comments": 123,
"itemTypeId": 123,
"lastActivityAt": "2007-12-03T10:15:30Z",
"rating": 987,
"ratingUp": 123,
"ratingDown": 123,
"dataSchema": "abc123",
"meta": {},
"Forum": ParentForum,
"Forums": [ChildForum]
}
}
}
removeForumComment
Description
Permanently Remove a Forum Comment
Response
Returns a ForumComment
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeForumComment($id: Int) {
removeForumComment(id: $id) {
id
createdAt
updatedAt
rating
forumId
topicId
parentId
authorId
locked
ratingUp
ratingDown
threadPath
bodyText
body
meta
Forum {
...ForumFragment
}
ForumTopic {
...ForumTopicFragment
}
ForumComment {
...ParentCommentFragment
}
ForumComments {
...ChildCommentFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeForumComment": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 123.45,
"forumId": 123,
"topicId": 987,
"parentId": 123,
"authorId": 987,
"locked": true,
"ratingUp": 987,
"ratingDown": 987,
"threadPath": "abc123",
"bodyText": "xyz789",
"body": {},
"meta": {},
"Forum": Forum,
"ForumTopic": ForumTopic,
"ForumComment": ParentComment,
"ForumComments": ChildComment,
"User": User
}
}
}
removeForumTopic
Description
Permanently Remove a Forum Topic
Response
Returns a ForumTopic
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeForumTopic($id: Int) {
removeForumTopic(id: $id) {
id
createdAt
updatedAt
title
slug
forumId
authorId
locked
pinned
comments
views
rating
ratingUp
ratingDown
bodyText
body
lastActivityAt
meta
Forum {
...ForumFragment
}
ForumComment {
...ForumCommentFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeForumTopic": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"slug": "abc123",
"forumId": 987,
"authorId": 123,
"locked": true,
"pinned": true,
"comments": 123,
"views": 123,
"rating": 987,
"ratingUp": 123,
"ratingDown": 123,
"bodyText": "xyz789",
"body": {},
"lastActivityAt": "2007-12-03T10:15:30Z",
"meta": {},
"Forum": Forum,
"ForumComment": ForumComment,
"User": User
}
}
}
removeIngredient
Response
Returns an Ingredient
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeIngredient($id: Int) {
removeIngredient(id: $id) {
id
active
ingredientTypeId
vendorId
density
code
createdAt
updatedAt
name
slug
description
image
discontinued
IngredientActive {
...IngredientActiveIngredientDefFragment
}
IngredientBase {
...IngredientBaseIngredientDefFragment
}
IngredientStash {
...IngredientStashFragment
}
IngredientType {
...IngredientTypeFragment
}
isStashed
stashes
Vendor {
...VendorFragment
}
IngredientTag {
...IngredientTagFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeIngredient": {
"id": 123,
"active": true,
"ingredientTypeId": 123,
"vendorId": 123,
"density": 123.45,
"code": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"slug": "abc123",
"description": "xyz789",
"image": "xyz789",
"discontinued": false,
"IngredientActive": [IngredientActiveIngredientDef],
"IngredientBase": [IngredientBaseIngredientDef],
"IngredientStash": IngredientStash,
"IngredientType": IngredientType,
"isStashed": true,
"stashes": 987,
"Vendor": Vendor,
"IngredientTag": [IngredientTag]
}
}
}
removeIngredientType
Response
Returns an IngredientType
Example
Query
mutation removeIngredientType {
removeIngredientType {
id
name
slug
description
}
}
Response
{
"data": {
"removeIngredientType": {
"id": 123,
"name": "abc123",
"slug": "abc123",
"description": "abc123"
}
}
}
removeItemType
Example
Query
mutation removeItemType($id: Int) {
removeItemType(id: $id) {
id
name
slug
description
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeItemType": {
"id": 987,
"name": "abc123",
"slug": "xyz789",
"description": "xyz789"
}
}
}
removeListFlavor
Description
Remove a Flavor from a Flavor List
Response
Returns a ListFlavor
Example
Query
mutation removeListFlavor(
$flavorListId: Int,
$flavorId: Int
) {
removeListFlavor(
flavorListId: $flavorListId,
flavorId: $flavorId
) {
flavorListId
flavorId
createdAt
FlavorList {
...FlavorListFragment
}
Flavor {
...FlavorFragment
}
}
}
Variables
{"flavorListId": 987, "flavorId": 987}
Response
{
"data": {
"removeListFlavor": {
"flavorListId": 123,
"flavorId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"FlavorList": FlavorList,
"Flavor": Flavor
}
}
}
removeRecipe
Description
Permanently Remove a Recipe
Response
Returns a RemoveRecipe
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeRecipe($id: Int) {
removeRecipe(id: $id) {
id
isPublished
userId
createdAt
deletedAt
updatedAt
rating
ratings
name
image
shareKey
slug
description
favorites
steepDays
color
isShared
isOriginal
isInProgress
isMTL
isSNV
licenseId
revisions
adaptedId
flavors
mixes
notes
publishedAt
restricted
restrictedAt
restrictedReason
totalMillipercent
views
comments
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeRecipe": {
"id": 987,
"isPublished": true,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 123.45,
"ratings": 123,
"name": "xyz789",
"image": "abc123",
"shareKey": "xyz789",
"slug": "xyz789",
"description": "xyz789",
"favorites": 987,
"steepDays": 987,
"color": "xyz789",
"isShared": false,
"isOriginal": false,
"isInProgress": true,
"isMTL": false,
"isSNV": true,
"licenseId": 987,
"revisions": 123,
"adaptedId": 123,
"flavors": 987,
"mixes": 987,
"notes": {},
"publishedAt": "2007-12-03T10:15:30Z",
"restricted": false,
"restrictedAt": "2007-12-03T10:15:30Z",
"restrictedReason": "abc123",
"totalMillipercent": 123.45,
"views": 123,
"comments": 123
}
}
}
removeRecipeComment
Description
Permanently Remove a Recipe Comment
Response
Returns a RecipeComment
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeRecipeComment($id: Int) {
removeRecipeComment(id: $id) {
id
recipeId
createdAt
updatedAt
title
rating
locked
parentId
authorId
ratingUp
ratingDown
threadPath
bodyText
body
meta
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeRecipeComment": {
"id": 987,
"recipeId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"rating": 123.45,
"locked": false,
"parentId": 987,
"authorId": 123,
"ratingUp": 123,
"ratingDown": 123,
"threadPath": "xyz789",
"bodyText": "abc123",
"body": {},
"meta": {},
"Recipe": SimpleRecipe,
"User": User
}
}
}
removeRecipeFormulation
Description
Permanently Remove a Recipe Formulation
Response
Returns a SimpleRecipeFormulation
Example
Query
mutation removeRecipeFormulation(
$recipeId: Int,
$formulationId: Int
) {
removeRecipeFormulation(
recipeId: $recipeId,
formulationId: $formulationId
) {
recipeId
formulationId
createdAt
updatedAt
recCount
recUsers
}
}
Variables
{"recipeId": 123, "formulationId": 123}
Response
{
"data": {
"removeRecipeFormulation": {
"recipeId": 123,
"formulationId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"recCount": 123,
"recUsers": {}
}
}
}
removeRetailFlavor
Description
Remove Retail Flavor
Example
Query
mutation removeRetailFlavor($id: Int) {
removeRetailFlavor(id: $id) {
id
vendorId
density
createdAt
updatedAt
name
slug
rating
ratings
url
views
favorites
averageMillipercent
baseId
recipes
recMinMillipercent
recMaxMillipercent
vendorMillipercent
vendorUrl
discontinued
isFavorite
isStashed
FlavorStash {
...FlavorStashFragment
}
stashes
Vendor {
...VendorFragment
}
FlavorBase {
...IngredientFragment
}
RetailFlavor {
...RetailFlavorFragment
}
Sellers {
...RetailFlavorFragment
}
vendorPercent
flavorUsage
FlavorTag {
...FlavorTagFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeRetailFlavor": {
"id": 123,
"vendorId": 123,
"density": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"slug": "xyz789",
"rating": 987.65,
"ratings": 123,
"url": "abc123",
"views": 987,
"favorites": 123,
"averageMillipercent": 987,
"baseId": 123,
"recipes": 123,
"recMinMillipercent": 987,
"recMaxMillipercent": 987,
"vendorMillipercent": 123,
"vendorUrl": "xyz789",
"discontinued": true,
"isFavorite": false,
"isStashed": true,
"FlavorStash": FlavorStash,
"stashes": 123,
"Vendor": Vendor,
"FlavorBase": Ingredient,
"RetailFlavor": RetailFlavor,
"Sellers": [RetailFlavor],
"vendorPercent": 987.65,
"flavorUsage": {},
"FlavorTag": [FlavorTag]
}
}
}
removeRetailVendor
Description
Remove Retail Vendor
Response
Returns a RetailVendor
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeRetailVendor($id: Int) {
removeRetailVendor(id: $id) {
id
createdAt
updatedAt
vendorId
slug
active
sellerId
flavorUrlPattern
ingredientUrlPattern
clicks
meta
Flavor {
...FlavorFragment
}
Vendor_RetailVendor_sellerIdToVendor {
...VendorFragment
}
Vendor_RetailVendor_vendorIdToVendor {
...VendorFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"removeRetailVendor": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"vendorId": 123,
"slug": "abc123",
"active": false,
"sellerId": 987,
"flavorUrlPattern": "abc123",
"ingredientUrlPattern": "xyz789",
"clicks": 123,
"meta": {},
"Flavor": Flavor,
"Vendor_RetailVendor_sellerIdToVendor": Vendor,
"Vendor_RetailVendor_vendorIdToVendor": Vendor
}
}
}
removeReview
Description
Permanently Remove a Review
Response
Returns a Review
Example
Query
mutation removeReview(
$type: String,
$id: Int,
$flavorId: Int,
$recipeId: Int,
$vendorId: Int,
$mixerId: Int
) {
removeReview(
type: $type,
id: $id,
flavorId: $flavorId,
recipeId: $recipeId,
vendorId: $vendorId,
mixerId: $mixerId
) {
id
userId
rating
createdAt
updatedAt
title
body
User {
...UserFragment
}
}
}
Variables
{
"type": "abc123",
"id": 987,
"flavorId": 987,
"recipeId": 987,
"vendorId": 123,
"mixerId": 123
}
Response
{
"data": {
"removeReview": {
"id": 123,
"userId": 987,
"rating": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"body": "abc123",
"User": User
}
}
}
removeRole
Description
Remove a Role
removeRolePermission
Description
Remove a Role Permission
Response
Returns a RolePermission
Example
Query
mutation removeRolePermission(
$roleId: Int,
$permissionSubjectId: Int,
$permissionActionId: Int
) {
removeRolePermission(
roleId: $roleId,
permissionSubjectId: $permissionSubjectId,
permissionActionId: $permissionActionId
) {
roleId
permissionSubjectId
permissionActionId
inverted
conditions
reason
ItemType {
...ItemTypeFragment
}
ItemAction {
...ItemActionFragment
}
Role {
...RoleFragment
}
}
}
Variables
{"roleId": 987, "permissionSubjectId": 987, "permissionActionId": 987}
Response
{
"data": {
"removeRolePermission": {
"roleId": 987,
"permissionSubjectId": 987,
"permissionActionId": 987,
"inverted": true,
"conditions": {},
"reason": "xyz789",
"ItemType": ItemType,
"ItemAction": ItemAction,
"Role": Role
}
}
}
removeUser
Description
Permanently Remove a User
Example
Query
mutation removeUser($id: Int) {
removeUser(id: $id) {
id
username
image
createdAt
updatedAt
description
favorites
recipes
rating
ratings
publicRecipes
flavors
interests
location
restricted
isFavorite
imageThumb
imageUrl
isFollowing
isFollower
followers
publicInventory
showFollowers
showFollowing
Country {
...CountryFragment
}
UserBadge {
...BadgeAssignedToItemFragment
}
UserRole {
...UserRoleFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"removeUser": {
"id": 987,
"username": "abc123",
"image": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"favorites": 123,
"recipes": 987,
"rating": 987.65,
"ratings": 987,
"publicRecipes": 123,
"flavors": 987,
"interests": "abc123",
"location": 123,
"restricted": false,
"isFavorite": true,
"imageThumb": "xyz789",
"imageUrl": "xyz789",
"isFollowing": false,
"isFollower": true,
"followers": 123,
"publicInventory": true,
"showFollowers": true,
"showFollowing": true,
"Country": Country,
"UserBadge": [BadgeAssignedToItem],
"UserRole": [UserRole]
}
}
}
removeUserRole
Description
Remove A User Role
Example
Query
mutation removeUserRole(
$userId: Int,
$roleId: Int
) {
removeUserRole(
userId: $userId,
roleId: $roleId
) {
userId
active
roleId
Role {
...RoleFragment
}
User {
...UserFragment
}
}
}
Variables
{"userId": 123, "roleId": 987}
Response
{
"data": {
"removeUserRole": {
"userId": 987,
"active": false,
"roleId": 987,
"Role": Role,
"User": User
}
}
}
removeVendor
Description
Remove Vendor
Example
Query
mutation removeVendor($id: Int) {
removeVendor(id: $id) {
id
createdAt
updatedAt
name
description
favorites
rating
ratings
recipes
image
slug
active
abbreviation
vendorTypeId
location
couponCode
referralUrl
referralParam
flavorUrlPattern
ingredientUrlPattern
isFavorite
imageThumb
imageUrl
Country {
...CountryFragment
}
VendorBadge {
...BadgeAssignedToItemFragment
}
VendorType {
...VendorTypeFragment
}
VendorWebsite {
...VendorWebsiteFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeVendor": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"description": "xyz789",
"favorites": 123,
"rating": 987.65,
"ratings": 987,
"recipes": 987,
"image": "abc123",
"slug": "abc123",
"active": false,
"abbreviation": "abc123",
"vendorTypeId": 123,
"location": 987,
"couponCode": "xyz789",
"referralUrl": "abc123",
"referralParam": "xyz789",
"flavorUrlPattern": "xyz789",
"ingredientUrlPattern": "xyz789",
"isFavorite": true,
"imageThumb": "abc123",
"imageUrl": "abc123",
"Country": Country,
"VendorBadge": [BadgeAssignedToItem],
"VendorType": VendorType,
"VendorWebsite": [VendorWebsite]
}
}
}
removeVendorType
Description
Remove Vendor Type
Response
Returns a VendorType
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation removeVendorType($id: Int) {
removeVendorType(id: $id) {
id
name
slug
description
}
}
Variables
{"id": 987}
Response
{
"data": {
"removeVendorType": {
"id": 987,
"name": "xyz789",
"slug": "abc123",
"description": "xyz789"
}
}
}
requestUserReset
Description
Request Password Reset
Response
Returns a RequestUserReset
Example
Query
mutation requestUserReset(
$email: String,
$username: String
) {
requestUserReset(
email: $email,
username: $username
) {
sent
email
}
}
Variables
{
"email": "abc123",
"username": "abc123"
}
Response
{
"data": {
"requestUserReset": {
"sent": false,
"email": "xyz789"
}
}
}
resendCode
Description
Resend User Activation Code
Response
Returns a Void
Example
Query
mutation resendCode {
resendCode
}
Response
{"data": {"resendCode": null}}
resetPassword
Description
Update Password with Reset
Response
Returns a UserPasswordReset
Example
Query
mutation resetPassword(
$id: Int,
$resetKey: String,
$password: String
) {
resetPassword(
id: $id,
resetKey: $resetKey,
password: $password
) {
reset
}
}
Variables
{
"id": 987,
"resetKey": "abc123",
"password": "abc123"
}
Response
{"data": {"resetPassword": {"reset": true}}}
restrictRecipe
Description
Restrict or Unrestrict a Recipe
Response
Returns a Recipe
Example
Query
mutation restrictRecipe(
$id: Int,
$restricted: Boolean,
$restrictedReason: String
) {
restrictRecipe(
id: $id,
restricted: $restricted,
restrictedReason: $restrictedReason
) {
id
isPublished
userId
createdAt
deletedAt
updatedAt
rating
ratings
name
image
shareKey
slug
description
favorites
steepDays
color
isShared
isOriginal
isInProgress
isMTL
isSNV
licenseId
revisions
adaptedId
flavors
mixes
notes
publishedAt
restricted
restrictedAt
restrictedReason
totalMillipercent
views
comments
imageUrl
imageThumb
isFavorite
recipeShare
flavorCount
totalPercent
License {
...LicenseFragment
}
RecipeBadge {
...BadgeAssignedToItemFragment
}
RecipeFlavor {
...RecipeFlavorFragment
}
User {
...UserFragment
}
AdaptedRecipe {
...SimpleRecipeFragment
}
RecipeTag {
...RecipeTagFragment
}
}
}
Variables
{
"id": 123,
"restricted": false,
"restrictedReason": "abc123"
}
Response
{
"data": {
"restrictRecipe": {
"id": 123,
"isPublished": false,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 123.45,
"ratings": 987,
"name": "xyz789",
"image": "abc123",
"shareKey": "xyz789",
"slug": "xyz789",
"description": "xyz789",
"favorites": 123,
"steepDays": 987,
"color": "xyz789",
"isShared": false,
"isOriginal": false,
"isInProgress": true,
"isMTL": true,
"isSNV": true,
"licenseId": 123,
"revisions": 987,
"adaptedId": 987,
"flavors": 123,
"mixes": 987,
"notes": {},
"publishedAt": "2007-12-03T10:15:30Z",
"restricted": false,
"restrictedAt": "2007-12-03T10:15:30Z",
"restrictedReason": "xyz789",
"totalMillipercent": 987.65,
"views": 987,
"comments": 123,
"imageUrl": "abc123",
"imageThumb": "abc123",
"isFavorite": false,
"recipeShare": {},
"flavorCount": 987,
"totalPercent": 123.45,
"License": License,
"RecipeBadge": [BadgeAssignedToItem],
"RecipeFlavor": [RecipeFlavor],
"User": User,
"AdaptedRecipe": SimpleRecipe,
"RecipeTag": [RecipeTag]
}
}
}
sendMessage
Description
Send a Message to a New or Existing Thread
Response
Returns a MessageThread
Arguments
| Name | Description |
|---|---|
threadId - Int
|
|
toUser - [MessageToUserList]
|
|
subject - String
|
|
body - String
|
|
support - Boolean
|
|
report - Boolean
|
|
ticket - TicketInput
|
Example
Query
mutation sendMessage(
$threadId: Int,
$toUser: [MessageToUserList],
$subject: String,
$body: String,
$support: Boolean,
$report: Boolean,
$ticket: TicketInput
) {
sendMessage(
threadId: $threadId,
toUser: $toUser,
subject: $subject,
body: $body,
support: $support,
report: $report,
ticket: $ticket
) {
id
createdAt
updatedAt
archived
locked
subject
support
report
ticketId
MessageUser {
...MessageUserFragment
}
Message {
...MessageFragment
}
Ticket {
...TicketFragment
}
User {
...UserFragment
}
}
}
Variables
{
"threadId": 123,
"toUser": [MessageToUserList],
"subject": "abc123",
"body": "abc123",
"support": true,
"report": false,
"ticket": TicketInput
}
Response
{
"data": {
"sendMessage": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"archived": false,
"locked": false,
"subject": "abc123",
"support": false,
"report": false,
"ticketId": 987,
"MessageUser": [MessageUser],
"Message": [Message],
"Ticket": Ticket,
"User": User
}
}
}
unarchiveMessage
Description
Unarchive a Message Thread
Response
Returns a MessageThread
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation unarchiveMessage($id: Int) {
unarchiveMessage(id: $id) {
id
createdAt
updatedAt
archived
locked
subject
support
report
ticketId
MessageUser {
...MessageUserFragment
}
Message {
...MessageFragment
}
Ticket {
...TicketFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"unarchiveMessage": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"archived": true,
"locked": false,
"subject": "abc123",
"support": false,
"report": true,
"ticketId": 123,
"MessageUser": [MessageUser],
"Message": [Message],
"Ticket": Ticket,
"User": User
}
}
}
unassignBadge
Description
Unassign a Badge from an Item
Response
Returns an AssignBadge
Example
Query
mutation unassignBadge(
$badgeId: Int,
$recipeId: Int,
$userId: Int,
$vendorId: Int,
$info: String
) {
unassignBadge(
badgeId: $badgeId,
recipeId: $recipeId,
userId: $userId,
vendorId: $vendorId,
info: $info
) {
badgeId
Badge {
...BadgeFragment
}
}
}
Variables
{
"badgeId": 987,
"recipeId": 987,
"userId": 987,
"vendorId": 987,
"info": "abc123"
}
Response
{
"data": {
"unassignBadge": {"badgeId": 987, "Badge": Badge}
}
}
unassignDefaultFormulation
Description
Unassign from Community Default
Response
Returns a Formulation
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation unassignDefaultFormulation($id: Int) {
unassignDefaultFormulation(id: $id) {
id
name
userId
createdAt
updatedAt
isPublished
description
favorites
mixes
flavorMultiplier
isOriginal
adaptedId
communityDefault
isFavorite
recommendedBy
recipes
recipeUserId
RecipeFormulation {
...RecipeFormulationFragment
}
relationship {
...SimpleRecipeFormulationFragment
}
FormulationIngredient {
...FormulationIngredientFragment
}
User {
...UserFragment
}
AdaptedFormulation {
...AdaptedFormulationFragment
}
FormulationTag {
...FormulationTagFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"unassignDefaultFormulation": {
"id": 123,
"name": "abc123",
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"isPublished": false,
"description": "xyz789",
"favorites": 123,
"mixes": 987,
"flavorMultiplier": 987.65,
"isOriginal": true,
"adaptedId": 123,
"communityDefault": false,
"isFavorite": true,
"recommendedBy": {},
"recipes": 987,
"recipeUserId": 987,
"RecipeFormulation": [RecipeFormulation],
"relationship": SimpleRecipeFormulation,
"FormulationIngredient": [FormulationIngredient],
"User": User,
"AdaptedFormulation": AdaptedFormulation,
"FormulationTag": [FormulationTag]
}
}
}
undeleteRecipe
Description
Undelete a Recipe
Response
Returns an UndeleteRecipe
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation undeleteRecipe($id: Int) {
undeleteRecipe(id: $id) {
id
isPublished
userId
createdAt
deletedAt
updatedAt
rating
ratings
name
image
shareKey
slug
description
favorites
steepDays
color
isShared
isOriginal
isInProgress
isMTL
isSNV
licenseId
revisions
adaptedId
flavors
mixes
notes
publishedAt
restricted
restrictedAt
restrictedReason
totalMillipercent
views
comments
}
}
Variables
{"id": 123}
Response
{
"data": {
"undeleteRecipe": {
"id": 987,
"isPublished": true,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 123.45,
"ratings": 987,
"name": "xyz789",
"image": "xyz789",
"shareKey": "abc123",
"slug": "xyz789",
"description": "abc123",
"favorites": 123,
"steepDays": 123,
"color": "abc123",
"isShared": true,
"isOriginal": true,
"isInProgress": false,
"isMTL": true,
"isSNV": true,
"licenseId": 123,
"revisions": 987,
"adaptedId": 123,
"flavors": 123,
"mixes": 987,
"notes": {},
"publishedAt": "2007-12-03T10:15:30Z",
"restricted": false,
"restrictedAt": "2007-12-03T10:15:30Z",
"restrictedReason": "xyz789",
"totalMillipercent": 123.45,
"views": 987,
"comments": 987
}
}
}
unfollow
Example
Query
mutation unfollow($followUserId: Int) {
unfollow(followUserId: $followUserId) {
followUserId
userId
createdAt
User {
...UserFragment
}
}
}
Variables
{"followUserId": 987}
Response
{
"data": {
"unfollow": {
"followUserId": 987,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"User": User
}
}
}
upVoteFlavorNote
Response
Returns a FlavorNote
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation upVoteFlavorNote($id: Int) {
upVoteFlavorNote(id: $id) {
id
userId
flavorId
createdAt
updatedAt
notes
shared
steep
score
difficulty
ratingUp
ratingDown
solo
mix
equipment
method
profile
pairing
Flavor {
...FlavorFragment
}
User {
...UserFragment
}
Vendor {
...VendorFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"upVoteFlavorNote": {
"id": 987,
"userId": 987,
"flavorId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"notes": "abc123",
"shared": true,
"steep": 987,
"score": 987,
"difficulty": 123,
"ratingUp": 123,
"ratingDown": 987,
"solo": 987.65,
"mix": 123.45,
"equipment": "xyz789",
"method": "abc123",
"profile": "abc123",
"pairing": "xyz789",
"Flavor": Flavor,
"User": User,
"Vendor": Vendor
}
}
}
updateBadge
Description
Update a Badge
Response
Returns a Badge
Example
Query
mutation updateBadge(
$id: Int,
$supersedes: Int,
$name: String,
$image: String,
$icon: String,
$description: String
) {
updateBadge(
id: $id,
supersedes: $supersedes,
name: $name,
image: $image,
icon: $icon,
description: $description
) {
id
createdAt
updatedAt
name
image
description
itemTypeId
supersedes
icon
ItemType {
...ItemTypeFragment
}
}
}
Variables
{
"id": 987,
"supersedes": 123,
"name": "abc123",
"image": "xyz789",
"icon": "xyz789",
"description": "xyz789"
}
Response
{
"data": {
"updateBadge": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"image": "abc123",
"description": "abc123",
"itemTypeId": 987,
"supersedes": 987,
"icon": "abc123",
"ItemType": ItemType
}
}
}
updateBatch
Description
Update a Batch
Response
Returns a Batch
Example
Query
mutation updateBatch(
$id: Int,
$name: String,
$notes: JSON,
$cost: Float,
$data: JSONObject,
$desiredMixingPercent: Float,
$amountRemaining: Float,
$isForSale: Boolean
) {
updateBatch(
id: $id,
name: $name,
notes: $notes,
cost: $cost,
data: $data,
desiredMixingPercent: $desiredMixingPercent,
amountRemaining: $amountRemaining,
isForSale: $isForSale
) {
id
userId
recipeId
formulationId
createdAt
updatedAt
name
cost
batchSize
amountRemaining
version
lot
notes
data
desiredMixingPercent
isForSale
wasSold
Formulation {
...FormulationFragment
}
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{
"id": 987,
"name": "xyz789",
"notes": {},
"cost": 987.65,
"data": {},
"desiredMixingPercent": 123.45,
"amountRemaining": 123.45,
"isForSale": false
}
Response
{
"data": {
"updateBatch": {
"id": 987,
"userId": 987,
"recipeId": 123,
"formulationId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"cost": 123.45,
"batchSize": 123.45,
"amountRemaining": 123.45,
"version": "abc123",
"lot": "xyz789",
"notes": {},
"data": {},
"desiredMixingPercent": 123.45,
"isForSale": true,
"wasSold": true,
"Formulation": Formulation,
"Recipe": SimpleRecipe,
"User": User
}
}
}
updateBatchRequest
Description
Update a Batch Request
Response
Returns a BatchRequest
Example
Query
mutation updateBatchRequest(
$id: Int,
$amountRequested: Float,
$isActive: Boolean,
$batchLot: String
) {
updateBatchRequest(
id: $id,
amountRequested: $amountRequested,
isActive: $isActive,
batchLot: $batchLot
) {
id
userId
recipeId
createdAt
updatedAt
batchLot
amountRequested
isActive
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
Batch {
...SaleBatchFragment
}
}
}
Variables
{
"id": 123,
"amountRequested": 123.45,
"isActive": true,
"batchLot": "abc123"
}
Response
{
"data": {
"updateBatchRequest": {
"id": 123,
"userId": 123,
"recipeId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"batchLot": "abc123",
"amountRequested": 987.65,
"isActive": true,
"Recipe": SimpleRecipe,
"User": User,
"Batch": SaleBatch
}
}
}
updateDynamicPage
Description
Update A Dynamic Page
Response
Returns a DynamicPage
Arguments
| Name | Description |
|---|---|
id - Int
|
|
title - String
|
|
heading - String
|
|
content - JSONObject
|
Example
Query
mutation updateDynamicPage(
$id: Int,
$title: String,
$heading: String,
$content: JSONObject
) {
updateDynamicPage(
id: $id,
title: $title,
heading: $heading,
content: $content
) {
id
slug
title
createdAt
updatedAt
content
folder
heading
}
}
Variables
{
"id": 987,
"title": "xyz789",
"heading": "xyz789",
"content": {}
}
Response
{
"data": {
"updateDynamicPage": {
"id": 123,
"slug": "xyz789",
"title": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"content": {},
"folder": "abc123",
"heading": "xyz789"
}
}
}
updateFlavor
Description
Update a Flavor
Response
Returns a Flavor
Example
Query
mutation updateFlavor(
$id: Int,
$vendorId: Int,
$density: Float,
$averageMillipercent: Int,
$vendorPercent: Float,
$vendorMillipercent: Int,
$baseId: Int,
$name: String,
$slug: String,
$vendorUrl: String,
$discontinued: Boolean
) {
updateFlavor(
id: $id,
vendorId: $vendorId,
density: $density,
averageMillipercent: $averageMillipercent,
vendorPercent: $vendorPercent,
vendorMillipercent: $vendorMillipercent,
baseId: $baseId,
name: $name,
slug: $slug,
vendorUrl: $vendorUrl,
discontinued: $discontinued
) {
id
vendorId
density
createdAt
updatedAt
name
slug
rating
ratings
url
views
favorites
averageMillipercent
baseId
recipes
recMinMillipercent
recMaxMillipercent
vendorMillipercent
vendorUrl
discontinued
isFavorite
isStashed
FlavorStash {
...FlavorStashFragment
}
stashes
Vendor {
...VendorFragment
}
FlavorBase {
...IngredientFragment
}
RetailFlavor {
...RetailFlavorFragment
}
Sellers {
...RetailFlavorFragment
}
vendorPercent
flavorUsage
FlavorTag {
...FlavorTagFragment
}
}
}
Variables
{
"id": 123,
"vendorId": 987,
"density": 123.45,
"averageMillipercent": 987,
"vendorPercent": 987.65,
"vendorMillipercent": 123,
"baseId": 123,
"name": "xyz789",
"slug": "xyz789",
"vendorUrl": "abc123",
"discontinued": true
}
Response
{
"data": {
"updateFlavor": {
"id": 123,
"vendorId": 123,
"density": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"slug": "xyz789",
"rating": 123.45,
"ratings": 123,
"url": "abc123",
"views": 123,
"favorites": 123,
"averageMillipercent": 123,
"baseId": 123,
"recipes": 123,
"recMinMillipercent": 987,
"recMaxMillipercent": 123,
"vendorMillipercent": 123,
"vendorUrl": "xyz789",
"discontinued": false,
"isFavorite": true,
"isStashed": true,
"FlavorStash": FlavorStash,
"stashes": 987,
"Vendor": Vendor,
"FlavorBase": Ingredient,
"RetailFlavor": RetailFlavor,
"Sellers": [RetailFlavor],
"vendorPercent": 123.45,
"flavorUsage": {},
"FlavorTag": [FlavorTag]
}
}
}
updateFlavorList
Description
Update a Flavor List
Response
Returns a FlavorList
Example
Query
mutation updateFlavorList(
$id: Int,
$name: String,
$description: String,
$isPublic: Boolean
) {
updateFlavorList(
id: $id,
name: $name,
description: $description,
isPublic: $isPublic
) {
id
userId
createdAt
updatedAt
name
description
isPublic
ListFlavor {
...ListFlavorFragment
}
}
}
Variables
{
"id": 123,
"name": "xyz789",
"description": "xyz789",
"isPublic": true
}
Response
{
"data": {
"updateFlavorList": {
"id": 987,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"description": "abc123",
"isPublic": true,
"ListFlavor": [ListFlavor]
}
}
}
updateFlavorNote
Description
Update a Flavor Note
Response
Returns a FlavorNote
Example
Query
mutation updateFlavorNote(
$id: Int,
$shared: Boolean,
$steep: Int,
$score: Int,
$difficulty: Int,
$solo: Float,
$mix: Float,
$equipment: String,
$method: String,
$profile: String,
$pairing: String,
$notes: String
) {
updateFlavorNote(
id: $id,
shared: $shared,
steep: $steep,
score: $score,
difficulty: $difficulty,
solo: $solo,
mix: $mix,
equipment: $equipment,
method: $method,
profile: $profile,
pairing: $pairing,
notes: $notes
) {
id
userId
flavorId
createdAt
updatedAt
notes
shared
steep
score
difficulty
ratingUp
ratingDown
solo
mix
equipment
method
profile
pairing
Flavor {
...FlavorFragment
}
User {
...UserFragment
}
Vendor {
...VendorFragment
}
}
}
Variables
{
"id": 123,
"shared": true,
"steep": 987,
"score": 123,
"difficulty": 987,
"solo": 987.65,
"mix": 123.45,
"equipment": "xyz789",
"method": "xyz789",
"profile": "xyz789",
"pairing": "abc123",
"notes": "abc123"
}
Response
{
"data": {
"updateFlavorNote": {
"id": 987,
"userId": 123,
"flavorId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"notes": "abc123",
"shared": false,
"steep": 987,
"score": 987,
"difficulty": 987,
"ratingUp": 123,
"ratingDown": 123,
"solo": 987.65,
"mix": 123.45,
"equipment": "abc123",
"method": "abc123",
"profile": "xyz789",
"pairing": "abc123",
"Flavor": Flavor,
"User": User,
"Vendor": Vendor
}
}
}
updateFolder
Description
Update a Recipe Folder
Example
Query
mutation updateFolder(
$id: Int,
$name: String,
$description: String
) {
updateFolder(
id: $id,
name: $name,
description: $description
) {
id
userId
createdAt
updatedAt
name
description
FolderRecipe {
...FolderRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{
"id": 123,
"name": "xyz789",
"description": "xyz789"
}
Response
{
"data": {
"updateFolder": {
"id": 123,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"description": "abc123",
"FolderRecipe": [FolderRecipe],
"User": User
}
}
}
updateForumComment
Description
Update A Forum Comment
Response
Returns a ForumComment
Arguments
| Name | Description |
|---|---|
id - Int
|
|
bodyText - String
|
|
body - JSONObject
|
|
locked - Boolean
|
Example
Query
mutation updateForumComment(
$id: Int,
$bodyText: String,
$body: JSONObject,
$locked: Boolean
) {
updateForumComment(
id: $id,
bodyText: $bodyText,
body: $body,
locked: $locked
) {
id
createdAt
updatedAt
rating
forumId
topicId
parentId
authorId
locked
ratingUp
ratingDown
threadPath
bodyText
body
meta
Forum {
...ForumFragment
}
ForumTopic {
...ForumTopicFragment
}
ForumComment {
...ParentCommentFragment
}
ForumComments {
...ChildCommentFragment
}
User {
...UserFragment
}
}
}
Variables
{
"id": 987,
"bodyText": "xyz789",
"body": {},
"locked": true
}
Response
{
"data": {
"updateForumComment": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 123.45,
"forumId": 123,
"topicId": 987,
"parentId": 987,
"authorId": 123,
"locked": false,
"ratingUp": 123,
"ratingDown": 987,
"threadPath": "abc123",
"bodyText": "xyz789",
"body": {},
"meta": {},
"Forum": Forum,
"ForumTopic": ForumTopic,
"ForumComment": ParentComment,
"ForumComments": ChildComment,
"User": User
}
}
}
updateIngredient
Response
Returns an Ingredient
Example
Query
mutation updateIngredient(
$id: Int,
$active: Boolean,
$ingredientTypeId: Int,
$vendorId: Int,
$density: Float,
$code: String,
$name: String,
$slug: String,
$description: String,
$image: String,
$bases: JSON,
$discontinued: Boolean
) {
updateIngredient(
id: $id,
active: $active,
ingredientTypeId: $ingredientTypeId,
vendorId: $vendorId,
density: $density,
code: $code,
name: $name,
slug: $slug,
description: $description,
image: $image,
bases: $bases,
discontinued: $discontinued
) {
id
active
ingredientTypeId
vendorId
density
code
createdAt
updatedAt
name
slug
description
image
discontinued
IngredientActive {
...IngredientActiveIngredientDefFragment
}
IngredientBase {
...IngredientBaseIngredientDefFragment
}
IngredientStash {
...IngredientStashFragment
}
IngredientType {
...IngredientTypeFragment
}
isStashed
stashes
Vendor {
...VendorFragment
}
IngredientTag {
...IngredientTagFragment
}
}
}
Variables
{
"id": 987,
"active": false,
"ingredientTypeId": 123,
"vendorId": 123,
"density": 987.65,
"code": "xyz789",
"name": "xyz789",
"slug": "abc123",
"description": "xyz789",
"image": "xyz789",
"bases": {},
"discontinued": true
}
Response
{
"data": {
"updateIngredient": {
"id": 987,
"active": false,
"ingredientTypeId": 123,
"vendorId": 987,
"density": 987.65,
"code": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"slug": "abc123",
"description": "abc123",
"image": "xyz789",
"discontinued": false,
"IngredientActive": [IngredientActiveIngredientDef],
"IngredientBase": [IngredientBaseIngredientDef],
"IngredientStash": IngredientStash,
"IngredientType": IngredientType,
"isStashed": false,
"stashes": 987,
"Vendor": Vendor,
"IngredientTag": [IngredientTag]
}
}
}
updateIngredientType
Response
Returns an IngredientType
Example
Query
mutation updateIngredientType {
updateIngredientType {
id
name
slug
description
}
}
Response
{
"data": {
"updateIngredientType": {
"id": 123,
"name": "abc123",
"slug": "abc123",
"description": "xyz789"
}
}
}
updateItemType
Example
Query
mutation updateItemType(
$id: Int,
$name: String,
$description: String
) {
updateItemType(
id: $id,
name: $name,
description: $description
) {
id
name
slug
description
}
}
Variables
{
"id": 987,
"name": "abc123",
"description": "xyz789"
}
Response
{
"data": {
"updateItemType": {
"id": 123,
"name": "xyz789",
"slug": "abc123",
"description": "xyz789"
}
}
}
updateRecipeComment
Description
Update A Recipe Comment
Response
Returns a RecipeComment
Arguments
| Name | Description |
|---|---|
id - Int
|
|
title - String
|
|
bodyText - String
|
|
body - JSONObject
|
|
locked - Boolean
|
Example
Query
mutation updateRecipeComment(
$id: Int,
$title: String,
$bodyText: String,
$body: JSONObject,
$locked: Boolean
) {
updateRecipeComment(
id: $id,
title: $title,
bodyText: $bodyText,
body: $body,
locked: $locked
) {
id
recipeId
createdAt
updatedAt
title
rating
locked
parentId
authorId
ratingUp
ratingDown
threadPath
bodyText
body
meta
Recipe {
...SimpleRecipeFragment
}
User {
...UserFragment
}
}
}
Variables
{
"id": 987,
"title": "abc123",
"bodyText": "abc123",
"body": {},
"locked": false
}
Response
{
"data": {
"updateRecipeComment": {
"id": 987,
"recipeId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"rating": 123.45,
"locked": true,
"parentId": 987,
"authorId": 987,
"ratingUp": 123,
"ratingDown": 123,
"threadPath": "xyz789",
"bodyText": "xyz789",
"body": {},
"meta": {},
"Recipe": SimpleRecipe,
"User": User
}
}
}
updateRetailFlavor
Description
Update Retail Flavor
Response
Returns a Flavor
Example
Query
mutation updateRetailFlavor(
$id: Int,
$inStock: Boolean,
$active: Boolean,
$sellerId: Int,
$flavorId: Int,
$slug: String,
$clicks: Int,
$meta: JSONObject
) {
updateRetailFlavor(
id: $id,
inStock: $inStock,
active: $active,
sellerId: $sellerId,
flavorId: $flavorId,
slug: $slug,
clicks: $clicks,
meta: $meta
) {
id
vendorId
density
createdAt
updatedAt
name
slug
rating
ratings
url
views
favorites
averageMillipercent
baseId
recipes
recMinMillipercent
recMaxMillipercent
vendorMillipercent
vendorUrl
discontinued
isFavorite
isStashed
FlavorStash {
...FlavorStashFragment
}
stashes
Vendor {
...VendorFragment
}
FlavorBase {
...IngredientFragment
}
RetailFlavor {
...RetailFlavorFragment
}
Sellers {
...RetailFlavorFragment
}
vendorPercent
flavorUsage
FlavorTag {
...FlavorTagFragment
}
}
}
Variables
{
"id": 123,
"inStock": true,
"active": true,
"sellerId": 123,
"flavorId": 987,
"slug": "abc123",
"clicks": 987,
"meta": {}
}
Response
{
"data": {
"updateRetailFlavor": {
"id": 123,
"vendorId": 987,
"density": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"slug": "xyz789",
"rating": 123.45,
"ratings": 987,
"url": "abc123",
"views": 123,
"favorites": 123,
"averageMillipercent": 123,
"baseId": 123,
"recipes": 123,
"recMinMillipercent": 987,
"recMaxMillipercent": 987,
"vendorMillipercent": 987,
"vendorUrl": "abc123",
"discontinued": true,
"isFavorite": false,
"isStashed": true,
"FlavorStash": FlavorStash,
"stashes": 123,
"Vendor": Vendor,
"FlavorBase": Ingredient,
"RetailFlavor": RetailFlavor,
"Sellers": [RetailFlavor],
"vendorPercent": 123.45,
"flavorUsage": {},
"FlavorTag": [FlavorTag]
}
}
}
updateRetailVendor
Description
Update Retail Vendor
Response
Returns a RetailVendor
Example
Query
mutation updateRetailVendor(
$id: Int,
$active: Boolean,
$sellerId: Int,
$vendorId: Int,
$slug: String,
$flavorUrlPattern: String,
$ingredientUrlPattern: String,
$meta: JSONObject
) {
updateRetailVendor(
id: $id,
active: $active,
sellerId: $sellerId,
vendorId: $vendorId,
slug: $slug,
flavorUrlPattern: $flavorUrlPattern,
ingredientUrlPattern: $ingredientUrlPattern,
meta: $meta
) {
id
createdAt
updatedAt
vendorId
slug
active
sellerId
flavorUrlPattern
ingredientUrlPattern
clicks
meta
Flavor {
...FlavorFragment
}
Vendor_RetailVendor_sellerIdToVendor {
...VendorFragment
}
Vendor_RetailVendor_vendorIdToVendor {
...VendorFragment
}
}
}
Variables
{
"id": 987,
"active": true,
"sellerId": 123,
"vendorId": 987,
"slug": "abc123",
"flavorUrlPattern": "xyz789",
"ingredientUrlPattern": "xyz789",
"meta": {}
}
Response
{
"data": {
"updateRetailVendor": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"vendorId": 987,
"slug": "abc123",
"active": false,
"sellerId": 987,
"flavorUrlPattern": "abc123",
"ingredientUrlPattern": "xyz789",
"clicks": 123,
"meta": {},
"Flavor": Flavor,
"Vendor_RetailVendor_sellerIdToVendor": Vendor,
"Vendor_RetailVendor_vendorIdToVendor": Vendor
}
}
}
updateReview
Description
Update a Review
Response
Returns a Review
Example
Query
mutation updateReview(
$type: String,
$id: Int,
$flavorId: Int,
$recipeId: Int,
$formulationId: Int,
$vendorId: Int,
$mixerId: Int,
$rating: Float,
$title: String,
$body: String
) {
updateReview(
type: $type,
id: $id,
flavorId: $flavorId,
recipeId: $recipeId,
formulationId: $formulationId,
vendorId: $vendorId,
mixerId: $mixerId,
rating: $rating,
title: $title,
body: $body
) {
id
userId
rating
createdAt
updatedAt
title
body
User {
...UserFragment
}
}
}
Variables
{
"type": "xyz789",
"id": 987,
"flavorId": 987,
"recipeId": 123,
"formulationId": 123,
"vendorId": 123,
"mixerId": 987,
"rating": 123.45,
"title": "abc123",
"body": "abc123"
}
Response
{
"data": {
"updateReview": {
"id": 987,
"userId": 123,
"rating": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"body": "abc123",
"User": User
}
}
}
updateRole
Description
Update A Role
Example
Query
mutation updateRole(
$id: Int,
$name: String,
$description: String
) {
updateRole(
id: $id,
name: $name,
description: $description
) {
id
name
description
}
}
Variables
{
"id": 123,
"name": "xyz789",
"description": "xyz789"
}
Response
{
"data": {
"updateRole": {
"id": 123,
"name": "xyz789",
"description": "abc123"
}
}
}
updateRolePermission
Description
Update a Role Permission
Response
Returns a RolePermission
Example
Query
mutation updateRolePermission(
$roleId: Int,
$permissionSubjectId: Int,
$permissionActionId: Int,
$inverted: Boolean,
$conditions: JSON,
$reason: String
) {
updateRolePermission(
roleId: $roleId,
permissionSubjectId: $permissionSubjectId,
permissionActionId: $permissionActionId,
inverted: $inverted,
conditions: $conditions,
reason: $reason
) {
roleId
permissionSubjectId
permissionActionId
inverted
conditions
reason
ItemType {
...ItemTypeFragment
}
ItemAction {
...ItemActionFragment
}
Role {
...RoleFragment
}
}
}
Variables
{
"roleId": 987,
"permissionSubjectId": 123,
"permissionActionId": 123,
"inverted": true,
"conditions": {},
"reason": "xyz789"
}
Response
{
"data": {
"updateRolePermission": {
"roleId": 987,
"permissionSubjectId": 123,
"permissionActionId": 987,
"inverted": false,
"conditions": {},
"reason": "xyz789",
"ItemType": ItemType,
"ItemAction": ItemAction,
"Role": Role
}
}
}
updateTicket
Description
Update Ticket Status
Response
Returns a MessageThread
Example
Query
mutation updateTicket(
$id: Int,
$open: Boolean
) {
updateTicket(
id: $id,
open: $open
) {
id
createdAt
updatedAt
archived
locked
subject
support
report
ticketId
MessageUser {
...MessageUserFragment
}
Message {
...MessageFragment
}
Ticket {
...TicketFragment
}
User {
...UserFragment
}
}
}
Variables
{"id": 123, "open": false}
Response
{
"data": {
"updateTicket": {
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"archived": false,
"locked": false,
"subject": "xyz789",
"support": true,
"report": true,
"ticketId": 987,
"MessageUser": [MessageUser],
"Message": [Message],
"Ticket": Ticket,
"User": User
}
}
}
updateUser
Description
User Account Update
Response
Returns a CurrentUser
Arguments
| Name | Description |
|---|---|
username - String
|
|
email - String
|
|
newPassword - String
|
|
passwordConfirmation - String
|
|
description - String
|
|
interests - String
|
|
image - String
|
|
location - Int
|
Country ID |
allowContact - Boolean
|
|
allowOffers - Boolean
|
|
allowPartners - Boolean
|
|
darkMode - Boolean
|
|
lowStockThreshold - Int
|
|
publicInventory - Boolean
|
|
useSpecificDensities - Boolean
|
|
showFollowers - Boolean
|
|
showFollowing - Boolean
|
|
showRestricted - Boolean
|
|
warnRestricted - Boolean
|
|
defaultBatchSize - Int
|
|
defaultFlavorDensity - String
|
|
defaultFormulation - Int
|
|
contactEmail - String
|
|
setupVersion - String
|
|
file - Upload
|
Example
Query
mutation updateUser(
$username: String,
$email: String,
$newPassword: String,
$passwordConfirmation: String,
$description: String,
$interests: String,
$image: String,
$location: Int,
$allowContact: Boolean,
$allowOffers: Boolean,
$allowPartners: Boolean,
$darkMode: Boolean,
$lowStockThreshold: Int,
$publicInventory: Boolean,
$useSpecificDensities: Boolean,
$showFollowers: Boolean,
$showFollowing: Boolean,
$showRestricted: Boolean,
$warnRestricted: Boolean,
$defaultBatchSize: Int,
$defaultFlavorDensity: String,
$defaultFormulation: Int,
$contactEmail: String,
$setupVersion: String,
$file: Upload
) {
updateUser(
username: $username,
email: $email,
newPassword: $newPassword,
passwordConfirmation: $passwordConfirmation,
description: $description,
interests: $interests,
image: $image,
location: $location,
allowContact: $allowContact,
allowOffers: $allowOffers,
allowPartners: $allowPartners,
darkMode: $darkMode,
lowStockThreshold: $lowStockThreshold,
publicInventory: $publicInventory,
useSpecificDensities: $useSpecificDensities,
showFollowers: $showFollowers,
showFollowing: $showFollowing,
showRestricted: $showRestricted,
warnRestricted: $warnRestricted,
defaultBatchSize: $defaultBatchSize,
defaultFlavorDensity: $defaultFlavorDensity,
defaultFormulation: $defaultFormulation,
contactEmail: $contactEmail,
setupVersion: $setupVersion,
file: $file
) {
id
username
createdAt
updatedAt
email
banned
bannedAt
bannedEnd
bannedReason
bannedByUserId
confirmedAt
currentLoginDate
logins
prevLoginDate
resetAt
image
description
favorites
recipes
rating
ratings
publicRecipes
flavors
interests
location
restricted
settings
imageThumb
imageUrl
loggedIn
abilities
Session {
...SessionFragment
}
}
}
Variables
{
"username": "xyz789",
"email": "abc123",
"newPassword": "xyz789",
"passwordConfirmation": "xyz789",
"description": "abc123",
"interests": "xyz789",
"image": "xyz789",
"location": 987,
"allowContact": true,
"allowOffers": false,
"allowPartners": false,
"darkMode": true,
"lowStockThreshold": 987,
"publicInventory": true,
"useSpecificDensities": false,
"showFollowers": true,
"showFollowing": true,
"showRestricted": false,
"warnRestricted": true,
"defaultBatchSize": 987,
"defaultFlavorDensity": "abc123",
"defaultFormulation": 123,
"contactEmail": "abc123",
"setupVersion": "xyz789",
"file": Upload
}
Response
{
"data": {
"updateUser": {
"id": 987,
"username": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "xyz789",
"banned": false,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "abc123",
"bannedByUserId": 123,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 123,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z",
"image": "abc123",
"description": "abc123",
"favorites": 123,
"recipes": 987,
"rating": 123.45,
"ratings": 123,
"publicRecipes": 987,
"flavors": 987,
"interests": "abc123",
"location": 123,
"restricted": true,
"settings": {},
"imageThumb": "abc123",
"imageUrl": "xyz789",
"loggedIn": false,
"abilities": {},
"Session": [Session]
}
}
}
updateUserAdmin
Description
User Admin Update
Response
Returns a UserAdmin
Example
Query
mutation updateUserAdmin(
$id: Int,
$username: String,
$email: String,
$banned: Boolean,
$bannedReason: String,
$restricted: Boolean
) {
updateUserAdmin(
id: $id,
username: $username,
email: $email,
banned: $banned,
bannedReason: $bannedReason,
restricted: $restricted
) {
id
username
createdAt
updatedAt
email
banned
bannedAt
bannedEnd
bannedReason
bannedByUserId
confirmedAt
currentLoginDate
logins
prevLoginDate
resetAt
image
description
favorites
recipes
rating
ratings
publicRecipes
flavors
interests
location
restricted
settings
imageThumb
imageUrl
Session {
...SessionFragment
}
}
}
Variables
{
"id": 123,
"username": "xyz789",
"email": "xyz789",
"banned": true,
"bannedReason": "xyz789",
"restricted": true
}
Response
{
"data": {
"updateUserAdmin": {
"id": 987,
"username": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "xyz789",
"banned": false,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "abc123",
"bannedByUserId": 987,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 123,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z",
"image": "xyz789",
"description": "abc123",
"favorites": 987,
"recipes": 987,
"rating": 123.45,
"ratings": 987,
"publicRecipes": 987,
"flavors": 987,
"interests": "xyz789",
"location": 987,
"restricted": false,
"settings": {},
"imageThumb": "abc123",
"imageUrl": "abc123",
"Session": [Session]
}
}
}
updateUserLocation
Description
User Location Update
Response
Returns a CurrentUser
Arguments
| Name | Description |
|---|---|
location - Int
|
Country ID |
Example
Query
mutation updateUserLocation($location: Int) {
updateUserLocation(location: $location) {
id
username
createdAt
updatedAt
email
banned
bannedAt
bannedEnd
bannedReason
bannedByUserId
confirmedAt
currentLoginDate
logins
prevLoginDate
resetAt
image
description
favorites
recipes
rating
ratings
publicRecipes
flavors
interests
location
restricted
settings
imageThumb
imageUrl
loggedIn
abilities
Session {
...SessionFragment
}
}
}
Variables
{"location": 123}
Response
{
"data": {
"updateUserLocation": {
"id": 123,
"username": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "abc123",
"banned": true,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "xyz789",
"bannedByUserId": 123,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 987,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z",
"image": "abc123",
"description": "abc123",
"favorites": 987,
"recipes": 987,
"rating": 987.65,
"ratings": 987,
"publicRecipes": 987,
"flavors": 123,
"interests": "xyz789",
"location": 123,
"restricted": false,
"settings": {},
"imageThumb": "abc123",
"imageUrl": "abc123",
"loggedIn": false,
"abilities": {},
"Session": [Session]
}
}
}
updateUserRole
Description
Update A User Role
Example
Query
mutation updateUserRole(
$userId: Int,
$roleId: Int,
$active: Boolean
) {
updateUserRole(
userId: $userId,
roleId: $roleId,
active: $active
) {
userId
active
roleId
Role {
...RoleFragment
}
User {
...UserFragment
}
}
}
Variables
{"userId": 123, "roleId": 123, "active": false}
Response
{
"data": {
"updateUserRole": {
"userId": 123,
"active": false,
"roleId": 987,
"Role": Role,
"User": User
}
}
}
updateVendor
Description
Update Vendor
Response
Returns a Vendor
Arguments
| Name | Description |
|---|---|
id - Int
|
|
active - Boolean
|
|
vendorTypeId - Int
|
|
abbreviation - String
|
|
name - String
|
|
slug - String
|
|
location - Int
|
Country ID |
image - String
|
|
description - String
|
|
couponCode - String
|
|
referralUrl - String
|
|
referralParam - String
|
|
flavorUrlPattern - String
|
|
ingredientUrlPattern - String
|
|
file - Upload
|
|
websites - [VendorWebsiteInput]
|
Example
Query
mutation updateVendor(
$id: Int,
$active: Boolean,
$vendorTypeId: Int,
$abbreviation: String,
$name: String,
$slug: String,
$location: Int,
$image: String,
$description: String,
$couponCode: String,
$referralUrl: String,
$referralParam: String,
$flavorUrlPattern: String,
$ingredientUrlPattern: String,
$file: Upload,
$websites: [VendorWebsiteInput]
) {
updateVendor(
id: $id,
active: $active,
vendorTypeId: $vendorTypeId,
abbreviation: $abbreviation,
name: $name,
slug: $slug,
location: $location,
image: $image,
description: $description,
couponCode: $couponCode,
referralUrl: $referralUrl,
referralParam: $referralParam,
flavorUrlPattern: $flavorUrlPattern,
ingredientUrlPattern: $ingredientUrlPattern,
file: $file,
websites: $websites
) {
id
createdAt
updatedAt
name
description
favorites
rating
ratings
recipes
image
slug
active
abbreviation
vendorTypeId
location
couponCode
referralUrl
referralParam
flavorUrlPattern
ingredientUrlPattern
isFavorite
imageThumb
imageUrl
Country {
...CountryFragment
}
VendorBadge {
...BadgeAssignedToItemFragment
}
VendorType {
...VendorTypeFragment
}
VendorWebsite {
...VendorWebsiteFragment
}
}
}
Variables
{
"id": 123,
"active": false,
"vendorTypeId": 123,
"abbreviation": "abc123",
"name": "xyz789",
"slug": "xyz789",
"location": 123,
"image": "abc123",
"description": "xyz789",
"couponCode": "abc123",
"referralUrl": "abc123",
"referralParam": "abc123",
"flavorUrlPattern": "xyz789",
"ingredientUrlPattern": "xyz789",
"file": Upload,
"websites": [VendorWebsiteInput]
}
Response
{
"data": {
"updateVendor": {
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"description": "abc123",
"favorites": 987,
"rating": 123.45,
"ratings": 987,
"recipes": 987,
"image": "xyz789",
"slug": "xyz789",
"active": true,
"abbreviation": "abc123",
"vendorTypeId": 123,
"location": 123,
"couponCode": "xyz789",
"referralUrl": "xyz789",
"referralParam": "abc123",
"flavorUrlPattern": "xyz789",
"ingredientUrlPattern": "xyz789",
"isFavorite": true,
"imageThumb": "abc123",
"imageUrl": "abc123",
"Country": Country,
"VendorBadge": [BadgeAssignedToItem],
"VendorType": VendorType,
"VendorWebsite": [VendorWebsite]
}
}
}
updateVendorType
Description
Update Vendor Type
Response
Returns a VendorType
Example
Query
mutation updateVendorType(
$id: Int,
$name: String,
$slug: String,
$description: String
) {
updateVendorType(
id: $id,
name: $name,
slug: $slug,
description: $description
) {
id
name
slug
description
}
}
Variables
{
"id": 987,
"name": "xyz789",
"slug": "xyz789",
"description": "abc123"
}
Response
{
"data": {
"updateVendorType": {
"id": 123,
"name": "xyz789",
"slug": "abc123",
"description": "abc123"
}
}
}
uploadPageImage
Description
Upload an Image to use in a Dynamic Page
Response
Returns an UploadedFile
Example
Query
mutation uploadPageImage(
$base64: String,
$mime: String,
$name: String,
$imageWidth: Int
) {
uploadPageImage(
base64: $base64,
mime: $mime,
name: $name,
imageWidth: $imageWidth
) {
url
name
}
}
Variables
{
"base64": "xyz789",
"mime": "abc123",
"name": "xyz789",
"imageWidth": 987
}
Response
{
"data": {
"uploadPageImage": {
"url": "abc123",
"name": "xyz789"
}
}
}
Types
AdaptedFormulation
AssignBadge
Description
Badge Assignment to an Item
Possible Types
| AssignBadge Types |
|---|
Example
{"badgeId": 987, "Badge": Badge}
AssignRecipeBadge
Description
Badge Assignment to a Recipe
Example
{
"recipeId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"badgeId": 987,
"superseded": true,
"info": "xyz789",
"Badge": Badge,
"Recipe": Recipe
}
AssignUserBadge
Description
Badge Assignment to a User
Example
{
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"badgeId": 987,
"superseded": false,
"info": "abc123",
"Badge": Badge,
"User": User
}
AssignVendorBadge
Description
Badge Assignment to a Vendor
Example
{
"vendorId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"badgeId": 123,
"superseded": false,
"info": "abc123",
"Badge": Badge,
"Vendor": Vendor
}
Badge
Description
Badge Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
name - String
|
Identifier or Title |
image - String
|
Image Name with Extension |
description - String
|
Item Description |
itemTypeId - Int
|
Item Type (entity) Unique ID |
supersedes - Int
|
Supersede this Badge ID |
icon - String
|
Badge Icon |
ItemType - ItemType
|
Content Type |
Example
{
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"image": "abc123",
"description": "abc123",
"itemTypeId": 123,
"supersedes": 123,
"icon": "abc123",
"ItemType": ItemType
}
BadgeAssignedToItem
Description
Badge Definition as assigned to Items
Fields
| Field Name | Description |
|---|---|
recipeId - Int
|
Recipe ID |
userId - Int
|
User Unique Identifier |
vendorId - Int
|
Vendor Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
superseded - Boolean
|
Superseded by another Badge |
info - String
|
Info about or reason for the badge assignment |
Badge - Badge
|
Example
{
"recipeId": 987,
"userId": 987,
"vendorId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"superseded": false,
"info": "xyz789",
"Badge": Badge
}
BadgeFilter
Description
Badge Filters
Example
{
"search": "xyz789",
"userId": 987,
"recipeId": 123,
"vendorId": 123,
"type": "xyz789"
}
BadgeNode
BaseError
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
Batch
Description
Batch definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
recipeId - Int
|
Recipe ID |
formulationId - Int
|
Formulation Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
name - String
|
Identifier or Title |
cost - Float
|
Total Cost of the Batch |
batchSize - Float
|
Size of the Batch |
amountRemaining - Float
|
Remaining Amount of the Batch |
version - String
|
All the Flavors Version |
lot - String
|
Batch Lot Identifier |
notes - JSON
|
Batch Notes |
data - JSON
|
Batch Calculator Data |
desiredMixingPercent - Float
|
Percent to add a Flavor Shot at. Null if different type of batch |
isForSale - Boolean
|
Batch is available for sale |
wasSold - Boolean
|
Batch was ever available for sale |
Formulation - Formulation
|
|
Recipe - SimpleRecipe
|
|
User - User
|
Example
{
"id": 123,
"userId": 987,
"recipeId": 987,
"formulationId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"cost": 123.45,
"batchSize": 123.45,
"amountRemaining": 123.45,
"version": "abc123",
"lot": "abc123",
"notes": {},
"data": {},
"desiredMixingPercent": 123.45,
"isForSale": false,
"wasSold": false,
"Formulation": Formulation,
"Recipe": SimpleRecipe,
"User": User
}
BatchFilter
Description
Batch Filters
Fields
| Input Field | Description |
|---|---|
formulationId - Int
|
Formulation Unique Identifier |
recipeId - Int
|
Recipe ID |
search - String
|
Query String |
lot - String
|
Filter by Lot |
forSale - Boolean
|
Show only Batches marked for sale |
wasSold - Boolean
|
Filter on if ever sold status |
onlyMine - Boolean
|
Show only Batches for My Recipes |
notMine - Boolean
|
Show only Batches for Recipes By Other Users |
countries - [Int]
|
Filter by user countries |
Example
{
"formulationId": 987,
"recipeId": 987,
"search": "abc123",
"lot": "abc123",
"forSale": false,
"wasSold": false,
"onlyMine": true,
"notMine": true,
"countries": [987]
}
BatchNode
BatchRequest
Description
Batch Request definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
recipeId - Int
|
Recipe ID |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
batchLot - String
|
Batch filling the request |
amountRequested - Float
|
Requested Amount |
isActive - Boolean
|
Request active or closed/fulfilled |
Recipe - SimpleRecipe
|
|
User - User
|
|
Batch - SaleBatch
|
Example
{
"id": 123,
"userId": 123,
"recipeId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"batchLot": "xyz789",
"amountRequested": 987.65,
"isActive": true,
"Recipe": SimpleRecipe,
"User": User,
"Batch": SaleBatch
}
BatchRequestFilter
Description
Batch Request Filters
Fields
| Input Field | Description |
|---|---|
recipeId - Int
|
Recipe ID |
userId - Int
|
User Unique Identifier |
search - String
|
Query String |
otherUser - Boolean
|
Requests not by current user |
recipeSlug - String
|
Recipe unique slug |
canMake - RecipeStashFilter
|
|
isActive - Boolean
|
Filter by active/closed state |
countries - [Int]
|
Filter by user countries |
Example
{
"recipeId": 123,
"userId": 123,
"search": "xyz789",
"otherUser": true,
"recipeSlug": "xyz789",
"canMake": RecipeStashFilter,
"isActive": false,
"countries": [123]
}
BatchRequestNode
Description
Batch Request Node
Fields
| Field Name | Description |
|---|---|
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [BatchRequest]
|
Batch Requests |
Example
{"totalCount": 987, "count": 987, "nodes": [BatchRequest]}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
ChildComment
Description
Child Comment Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
rating - Float
|
Rating |
forumId - Int
|
Forum ID |
topicId - Int
|
Forum Topic ID |
parentId - Int
|
Parent Comment |
authorId - Int
|
Author User ID |
locked - Boolean
|
Parent Comment |
ratingUp - Int
|
Upvote |
ratingDown - Int
|
Downvote |
threadPath - String
|
Thread Sorting String |
bodyText - String
|
Body Reference Text |
body - JSONObject
|
Body Data |
meta - JSONObject
|
Comment Meta Data |
Example
{
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"forumId": 987,
"topicId": 987,
"parentId": 987,
"authorId": 123,
"locked": true,
"ratingUp": 987,
"ratingDown": 123,
"threadPath": "abc123",
"bodyText": "xyz789",
"body": {},
"meta": {}
}
ChildForum
Description
Child Forum Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
title - String
|
Item Title |
slug - String
|
Item Type Unique Identifier String |
description - String
|
Item Description |
image - String
|
Image Name with Extension |
parentId - Int
|
Parent Forum |
allowTopics - Boolean
|
Allowed to have topics or acts as a container |
externalData - Boolean
|
Uses data schema outside of Forum schema |
locked - Boolean
|
Forum Topics are Locked |
topics - Int
|
Topics Count |
comments - Int
|
Comments Count |
itemTypeId - Int
|
Item Type |
lastActivityAt - DateTime
|
Last forum activity |
rating - Int
|
Rating |
ratingUp - Int
|
Upvote |
ratingDown - Int
|
Downvote |
dataSchema - String
|
External data schema |
meta - JSONObject
|
Forum Meta Data |
Example
{
"id": 987,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"slug": "abc123",
"description": "xyz789",
"image": "abc123",
"parentId": 123,
"allowTopics": true,
"externalData": false,
"locked": false,
"topics": 123,
"comments": 123,
"itemTypeId": 123,
"lastActivityAt": "2007-12-03T10:15:30Z",
"rating": 987,
"ratingUp": 123,
"ratingDown": 987,
"dataSchema": "xyz789",
"meta": {}
}
Country
CurrentUser
Description
Current User definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
username - String
|
Unique Username |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
email - String
|
Email address for user |
banned - Boolean
|
Is Banned |
bannedAt - DateTime
|
Date banned |
bannedEnd - DateTime
|
Date unbanned |
bannedReason - String
|
Last Reason to be Banned |
bannedByUserId - Int
|
Last User to Ban this User |
confirmedAt - DateTime
|
Date User Confirmed |
currentLoginDate - DateTime
|
Date of last login |
logins - Int
|
Number of logins |
prevLoginDate - DateTime
|
Date of previous login |
resetAt - DateTime
|
Date User Password Reset |
image - String
|
Image Name with Extension |
description - String
|
Item Description |
favorites - Int
|
Total Favorited Count |
recipes - Int
|
Recipes |
rating - Float
|
Rating |
ratings - Int
|
Rating Count |
publicRecipes - Int
|
User Public Recipe Count |
flavors - Int
|
User Flavor Count |
interests - String
|
User Interests |
location - Int
|
User location |
restricted - Boolean
|
User Profile contains Restricted content |
settings - JSONObject
|
User settings |
imageThumb - String
|
Image Thumbnail |
imageUrl - String
|
URL to the Image |
loggedIn - Boolean
|
|
abilities - JSON
|
|
Session - [Session]
|
Example
{
"id": 987,
"username": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "abc123",
"banned": true,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "abc123",
"bannedByUserId": 123,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 987,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z",
"image": "xyz789",
"description": "xyz789",
"favorites": 123,
"recipes": 987,
"rating": 123.45,
"ratings": 987,
"publicRecipes": 987,
"flavors": 123,
"interests": "xyz789",
"location": 987,
"restricted": false,
"settings": {},
"imageThumb": "xyz789",
"imageUrl": "xyz789",
"loggedIn": true,
"abilities": {},
"Session": [Session]
}
DateTime
Description
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03T10:15:30Z"
DeleteRecipe
Description
Delete a Recipe Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
isPublished - Boolean
|
Is visible to all users |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
deletedAt - DateTime
|
Date and Time Deleted |
updatedAt - DateTime
|
Date and Time of Last Update |
rating - Float
|
Rating |
ratings - Int
|
Rating Count |
name - String
|
Identifier or Title |
image - String
|
Image Name with Extension |
shareKey - String
|
Recipe share key |
slug - String
|
Item Type Unique Identifier String |
description - String
|
Item Description |
favorites - Int
|
Total Favorited Count |
steepDays - Int
|
Conditioning time in days |
color - String
|
Pattern color override |
isShared - Boolean
|
Recipe is shared |
isOriginal - Boolean
|
Recipe is original |
isInProgress - Boolean
|
Recipe is in progress |
isMTL - Boolean
|
Recipe is mouth to lung |
isSNV - Boolean
|
Recipe is shake and vape |
licenseId - Int
|
Recipe License ID |
revisions - Int
|
Recipe revisions count |
adaptedId - Int
|
Recipe based on Recipe ID |
flavors - Int
|
Recipe Flavors count |
mixes - Int
|
Recipe Mixes count |
notes - JSON
|
Recipe notes |
publishedAt - DateTime
|
Recipe published date |
restricted - Boolean
|
Recipe contains Restricted content |
restrictedAt - DateTime
|
Recipe restricted date |
restrictedReason - String
|
Recipe restricted reason |
totalMillipercent - Float
|
Total flavoring millipercentage |
views - Int
|
Recipe Views count |
comments - Int
|
Recipe Comments count |
Example
{
"id": 123,
"isPublished": false,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"ratings": 123,
"name": "abc123",
"image": "abc123",
"shareKey": "xyz789",
"slug": "abc123",
"description": "xyz789",
"favorites": 123,
"steepDays": 123,
"color": "xyz789",
"isShared": false,
"isOriginal": false,
"isInProgress": true,
"isMTL": true,
"isSNV": false,
"licenseId": 123,
"revisions": 987,
"adaptedId": 123,
"flavors": 987,
"mixes": 123,
"notes": {},
"publishedAt": "2007-12-03T10:15:30Z",
"restricted": false,
"restrictedAt": "2007-12-03T10:15:30Z",
"restrictedReason": "xyz789",
"totalMillipercent": 123.45,
"views": 123,
"comments": 987
}
DynamicPage
Description
Dynamic Page Content
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
slug - String
|
Item Type Unique Identifier String |
title - String
|
Item Title |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
content - JSON
|
CMS JSON content |
folder - String
|
Page folder |
heading - String
|
Content Header |
Example
{
"id": 123,
"slug": "xyz789",
"title": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"content": {},
"folder": "xyz789",
"heading": "abc123"
}
Favorite
Description
Favorite Definition
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime
|
Date and Time Created |
Possible Types
| Favorite Types |
|---|
Example
{"createdAt": "2007-12-03T10:15:30Z"}
FavoriteFlavor
Description
Favorite Flavor Definition
Example
{
"flavorId": 123,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"Flavor": Flavor
}
FavoriteFormulation
Description
Favorite Formulation Definition
Fields
| Field Name | Description |
|---|---|
formulationId - Int
|
Formulation Unique Identifier |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
Formulation - Formulation
|
Example
{
"formulationId": 123,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"Formulation": Formulation
}
FavoriteRecipe
Description
Favorite Recipe Definition
Example
{
"recipeId": 123,
"shareKey": "xyz789",
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"Recipe": Recipe
}
FavoriteUser
FavoriteVendor
Description
Favorite Vendor Definition
Example
{
"vendorId": 987,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"Vendor": Vendor
}
Flavor
Description
Flavor definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
vendorId - Int
|
Vendor Unique Identifier |
density - Float
|
Specific Gravity |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
name - String
|
Identifier or Title |
slug - String
|
Item Type Unique Identifier String |
rating - Float
|
Rating |
ratings - Int
|
Rating Count |
url - String
|
Website Address |
views - Int
|
View Count |
favorites - Int
|
Total Favorited Count |
averageMillipercent - Int
|
Average millipercent this flavor is used |
baseId - Int
|
The base ingredient id of this flavor |
recipes - Int
|
Times used in a recipe |
recMinMillipercent - Int
|
Recommended minimum millipercent |
recMaxMillipercent - Int
|
Recommended maximum millipercent |
vendorMillipercent - Int
|
Vendor recommended usage millipercent |
vendorUrl - String
|
Vendor Website |
discontinued - Boolean
|
Flavor Discontinued |
isFavorite - Boolean
|
Is a Favorite |
isStashed - Boolean
|
Is in Stash |
FlavorStash - FlavorStash
|
|
stashes - Int
|
Flavor Stashes Count |
Vendor - Vendor
|
|
FlavorBase - Ingredient
|
|
RetailFlavor - RetailFlavor
|
|
Sellers - [RetailFlavor]
|
|
vendorPercent - Float
|
Vendor recommented use percent |
flavorUsage - JSON
|
|
FlavorTag - [FlavorTag]
|
Example
{
"id": 987,
"vendorId": 123,
"density": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"slug": "abc123",
"rating": 123.45,
"ratings": 123,
"url": "xyz789",
"views": 987,
"favorites": 987,
"averageMillipercent": 987,
"baseId": 123,
"recipes": 123,
"recMinMillipercent": 987,
"recMaxMillipercent": 123,
"vendorMillipercent": 987,
"vendorUrl": "abc123",
"discontinued": false,
"isFavorite": true,
"isStashed": false,
"FlavorStash": FlavorStash,
"stashes": 987,
"Vendor": Vendor,
"FlavorBase": Ingredient,
"RetailFlavor": RetailFlavor,
"Sellers": [RetailFlavor],
"vendorPercent": 123.45,
"flavorUsage": {},
"FlavorTag": [FlavorTag]
}
FlavorFilter
Description
Flavor Filters
Fields
| Input Field | Description |
|---|---|
vendorId - Int
|
Vendor Unique Identifier |
search - String
|
Query String |
isFavorite - Boolean
|
Is a Favorite |
isStashed - Boolean
|
Is in Stash |
averageMillipercent - FlavorFilterAverageMillipercent
|
Flavor Filter by Average Millipercent |
averagePercent - FlavorFilterAveragePercent
|
Flavor Filter by Average Percent |
recipes - FlavorFilterRecipes
|
Flavor Filter by Recipe Count |
vendors - [Int]
|
Flavor Filter by List of Vendor Unique Identifiers |
tag - TagTypeFilter
|
Tag Filters |
Example
{
"vendorId": 123,
"search": "abc123",
"isFavorite": false,
"isStashed": true,
"averageMillipercent": FlavorFilterAverageMillipercent,
"averagePercent": FlavorFilterAveragePercent,
"recipes": FlavorFilterRecipes,
"vendors": [123],
"tag": TagTypeFilter
}
FlavorFilterAverageMillipercent
FlavorFilterAveragePercent
FlavorFilterRecipes
FlavorList
Description
FlavorList definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
name - String
|
Identifier or Title |
description - String
|
Item Description |
isPublic - Boolean
|
Flavor List is Public |
ListFlavor - [ListFlavor]
|
ListFlavor List |
Example
{
"id": 987,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"description": "abc123",
"isPublic": true,
"ListFlavor": [ListFlavor]
}
FlavorListNode
Description
FlavorList Node
Fields
| Field Name | Description |
|---|---|
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [FlavorList]
|
FlavorList List |
Example
{"totalCount": 123, "count": 987, "nodes": [FlavorList]}
FlavorMatch
Description
Flavor Match definition
Example
{
"flavorId": 123,
"percent": 987.65,
"flavor": RequestedFlavorMatch,
"Flavor": Flavor,
"Errors": {},
"Flavors": [Flavor]
}
FlavorMatchExternalNames
FlavorNode
FlavorNote
Description
Flavor Note definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
flavorId - Int
|
Flavor Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
notes - String
|
Notes |
shared - Boolean
|
Is public |
steep - Int
|
Steep time |
score - Int
|
Rating |
difficulty - Int
|
Usage Difficulty |
ratingUp - Int
|
Users' Liked rating |
ratingDown - Int
|
Users' Disliked rating |
solo - Float
|
Solo usage percentage |
mix - Float
|
Mix usage percentage |
equipment - String
|
Devices used with this flavor |
method - String
|
Testing method |
profile - String
|
Description of the flavor profile |
pairing - String
|
Other flavors this flavor works well with |
Flavor - Flavor
|
Flavor |
User - User
|
User |
Vendor - Vendor
|
Vendor |
Example
{
"id": 987,
"userId": 123,
"flavorId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"notes": "xyz789",
"shared": true,
"steep": 987,
"score": 987,
"difficulty": 987,
"ratingUp": 123,
"ratingDown": 987,
"solo": 123.45,
"mix": 987.65,
"equipment": "abc123",
"method": "abc123",
"profile": "abc123",
"pairing": "abc123",
"Flavor": Flavor,
"User": User,
"Vendor": Vendor
}
FlavorNoteFilter
Description
Flavor Note Filters
Example
{
"vendorId": 123,
"flavorId": 987,
"search": "xyz789",
"isFavorite": false,
"isStashed": false,
"flavor": "abc123"
}
FlavorNoteNode
Description
Flavor Note Node
Fields
| Field Name | Description |
|---|---|
storage - String
|
Image Storage Location |
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [FlavorNote]
|
Flavor Notes |
Example
{
"storage": "abc123",
"totalCount": 123,
"count": 987,
"nodes": [FlavorNote]
}
FlavorReview
Description
Flavor Review Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
flavorId - Int
|
Flavor Unique Identifier |
userId - Int
|
User Unique Identifier |
rating - Float
|
Rating |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
title - String
|
Item Title |
body - String
|
Text Body |
User - User
|
|
Flavor - Flavor
|
Example
{
"id": 987,
"flavorId": 123,
"userId": 987,
"rating": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"body": "abc123",
"User": User,
"Flavor": Flavor
}
FlavorStash
Description
Flavor Stash definition
Fields
| Field Name | Description |
|---|---|
userId - Int
|
User Unique Identifier |
flavorId - Int
|
Flavor Unique Identifier |
isStashed - Boolean
|
Is in Stash |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
recipes - Int
|
Recipes |
stockLevel - Float
|
Total flavor amount on hold |
cost - Float
|
Flavor cost |
volume - Float
|
Flavor bottle size |
costPerML - Float
|
Ingredient cost for calculations |
location - String
|
Flavor location |
averageMillipercent - Int
|
Average Millipercent Used |
density - Float
|
Density Override |
Flavor - Flavor
|
|
User - User
|
Example
{
"userId": 123,
"flavorId": 123,
"isStashed": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"recipes": 123,
"stockLevel": 123.45,
"cost": 987.65,
"volume": 987.65,
"costPerML": 987.65,
"location": "abc123",
"averageMillipercent": 123,
"density": 987.65,
"Flavor": Flavor,
"User": User
}
FlavorStashFilter
Description
Flavor Stash Filters
Example
{
"vendorId": 987,
"search": "xyz789",
"isFavorite": false,
"isStashed": false,
"flavorId": 987,
"userId": 987,
"username": "xyz789"
}
FlavorStashNode
Description
Flavor Stash Node
Fields
| Field Name | Description |
|---|---|
storage - String
|
Image Storage Location |
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [FlavorStash]
|
Example
{
"storage": "xyz789",
"totalCount": 987,
"count": 987,
"nodes": [FlavorStash]
}
FlavorStatTopDef
Description
Top Flavors definition
Fields
| Field Name | Description |
|---|---|
Flavor - Flavor
|
Top Flavors |
Example
{"Flavor": Flavor}
FlavorStatTopNode
Description
Top Flavors Node
Fields
| Field Name | Description |
|---|---|
nodes - [FlavorStatTopDef]
|
Top Flavor List |
Example
{"nodes": [FlavorStatTopDef]}
FlavorTag
Description
Flavor Tag definition
Fields
| Field Name | Description |
|---|---|
flavorId - Int
|
Flavor Unique Identifier |
tagId - Int
|
Tag ID |
userId - Int
|
User Unique Identifier |
active - Boolean
|
Ingredient Activity |
name - String
|
Identifier or Title |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
tier - Int
|
Tag Hierarchy Level |
weight - Int
|
Tag Prominence |
rating - Int
|
Rating |
meta - JSONObject
|
Meta Data |
Flavor - Flavor
|
|
Tag - Tag
|
|
User - User
|
Example
{
"flavorId": 123,
"tagId": 123,
"userId": 987,
"active": true,
"name": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"tier": 987,
"weight": 987,
"rating": 987,
"meta": {},
"Flavor": Flavor,
"Tag": Tag,
"User": User
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
Folder
Description
Folder definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
name - String
|
Identifier or Title |
description - String
|
Item Description |
FolderRecipe - [FolderRecipe]
|
FolderRecipe List |
User - User
|
Example
{
"id": 123,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"description": "abc123",
"FolderRecipe": [FolderRecipe],
"User": User
}
FolderNode
FolderRecipe
Description
FolderRecipe definition
Example
{
"folderId": 987,
"recipeId": 987,
"shareKey": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"orderByName": true,
"Folder": Folder,
"Recipe": SimpleRecipe
}
FolderRecipeCreate
Description
Create a FolderRecipe Definition
Example
{
"folderId": 987,
"recipeId": 987,
"shareKey": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"Folder": Folder,
"Recipe": SimpleRecipe
}
FolderRecipeRemove
Description
Remove a FolderRecipe Definition
Example
{
"folderId": 987,
"recipeId": 987,
"shareKey": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"Folder": Folder,
"Recipe": SimpleRecipe
}
FollowDef
Formulation
Description
Formulation definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
name - String
|
Identifier or Title |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
isPublished - Boolean
|
Is visible to all users |
description - String
|
Item Description |
favorites - Int
|
Total Favorited Count |
mixes - Int
|
Mixes |
flavorMultiplier - Float
|
Flavor multiplier |
isOriginal - Boolean
|
Formulation is original |
adaptedId - Int
|
Formulation based on Formulation ID |
communityDefault - Boolean
|
Formulation is selected as a Community Default Formulation |
isFavorite - Boolean
|
Formulation is Favorite |
recommendedBy - JSON
|
Formulation is Recommended for selected Recipe by these users |
recipes - Int
|
Recipes Count |
recipeUserId - Int
|
Recipe Owner User ID |
RecipeFormulation - [RecipeFormulation]
|
|
relationship - SimpleRecipeFormulation
|
|
FormulationIngredient - [FormulationIngredient]
|
|
User - User
|
|
AdaptedFormulation - AdaptedFormulation
|
|
FormulationTag - [FormulationTag]
|
Example
{
"id": 123,
"name": "xyz789",
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"isPublished": true,
"description": "xyz789",
"favorites": 123,
"mixes": 123,
"flavorMultiplier": 123.45,
"isOriginal": true,
"adaptedId": 987,
"communityDefault": false,
"isFavorite": true,
"recommendedBy": {},
"recipes": 123,
"recipeUserId": 987,
"RecipeFormulation": [RecipeFormulation],
"relationship": SimpleRecipeFormulation,
"FormulationIngredient": [FormulationIngredient],
"User": User,
"AdaptedFormulation": AdaptedFormulation,
"FormulationTag": [FormulationTag]
}
FormulationFilter
Description
Formulation Filters
Fields
| Input Field | Description |
|---|---|
userId - Int
|
User Unique Identifier |
search - String
|
Query String |
recipeId - Int
|
Recipe ID |
ingredientId - Int
|
Ingredient Type Identifier |
isFavorite - Boolean
|
Favorite Formulations |
isPublished - Boolean
|
Show Published Formulations |
recent - Boolean
|
Recently Used by Recipe ID |
recommended - Boolean
|
Recommended by Recipe ID |
tag - TagTypeFilter
|
Tag Filters |
Example
{
"userId": 987,
"search": "xyz789",
"recipeId": 123,
"ingredientId": 987,
"isFavorite": false,
"isPublished": false,
"recent": false,
"recommended": true,
"tag": TagTypeFilter
}
FormulationIngredient
Description
Formulation Ingredient definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
ingredientId - Int
|
Ingredient Type Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
milliamount - Int
|
Amount x 1000 | Allows amounts to be defined without decimals |
ingredientUnit - String
|
Unit that pairs with the amount and milliamount fields |
variable - Boolean
|
Ingredient milliamount is the amount not occupied by all other components |
formulationId - Int
|
Formulation Unique ID |
amount - Float
|
Ingredient Amount |
strength - Float
|
Ingredient Strength |
activity - Float
|
Ingredient Activity |
Ingredient - Ingredient
|
Example
{
"id": 123,
"ingredientId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"milliamount": 123,
"ingredientUnit": "xyz789",
"variable": true,
"formulationId": 987,
"amount": 987.65,
"strength": 123.45,
"activity": 987.65,
"Ingredient": Ingredient
}
FormulationIngredientList
Description
Formulation Ingredient input multiple fields
Fields
| Input Field | Description |
|---|---|
id - Int
|
Unique Identifier |
ingredientId - Int
|
Ingredient Type Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
milliamount - Int
|
Amount x 1000 | Allows amounts to be defined without decimals |
ingredientUnit - String
|
Unit that pairs with the amount and milliamount fields |
variable - Boolean
|
Ingredient milliamount is the amount not occupied by all other components |
formulationId - Int
|
Formulation Unique ID |
amount - Float
|
Ingredient Amount |
strength - Float
|
Ingredient Strength |
activity - Float
|
Ingredient Activity |
Example
{
"id": 123,
"ingredientId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"milliamount": 123,
"ingredientUnit": "abc123",
"variable": true,
"formulationId": 987,
"amount": 123.45,
"strength": 123.45,
"activity": 987.65
}
FormulationNode
Description
Formulation Node
Example
{
"storage": "xyz789",
"totalCount": 123,
"count": 123,
"recipeId": 987,
"recipeUserId": 123,
"nodes": [Formulation]
}
FormulationTag
Description
Formulation Tag definition
Fields
| Field Name | Description |
|---|---|
formulationId - Int
|
Formulation Unique Identifier |
tagId - Int
|
Tag ID |
userId - Int
|
User Unique Identifier |
active - Boolean
|
Ingredient Activity |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
weight - Int
|
Tag Prominence |
rating - Int
|
Rating |
meta - JSONObject
|
Meta Data |
Formulation - Formulation
|
|
Tag - Tag
|
|
User - User
|
Example
{
"formulationId": 987,
"tagId": 987,
"userId": 123,
"active": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"weight": 123,
"rating": 987,
"meta": {},
"Formulation": Formulation,
"Tag": Tag,
"User": User
}
Forum
Description
Forum Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
title - String
|
Item Title |
slug - String
|
Item Type Unique Identifier String |
description - String
|
Item Description |
image - String
|
Image Name with Extension |
parentId - Int
|
Parent Forum |
allowTopics - Boolean
|
Allowed to have topics or acts as a container |
externalData - Boolean
|
Uses data schema outside of Forum schema |
locked - Boolean
|
Forum Topics are Locked |
topics - Int
|
Topics Count |
comments - Int
|
Comments Count |
itemTypeId - Int
|
Item Type |
lastActivityAt - DateTime
|
Last forum activity |
rating - Int
|
Rating |
ratingUp - Int
|
Upvote |
ratingDown - Int
|
Downvote |
dataSchema - String
|
External data schema |
meta - JSONObject
|
Forum Meta Data |
Forum - ParentForum
|
|
Forums - [ChildForum]
|
Example
{
"id": 123,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"slug": "abc123",
"description": "xyz789",
"image": "abc123",
"parentId": 987,
"allowTopics": true,
"externalData": true,
"locked": false,
"topics": 987,
"comments": 987,
"itemTypeId": 123,
"lastActivityAt": "2007-12-03T10:15:30Z",
"rating": 987,
"ratingUp": 123,
"ratingDown": 987,
"dataSchema": "abc123",
"meta": {},
"Forum": ParentForum,
"Forums": [ChildForum]
}
ForumComment
Description
Forum Comment Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
rating - Float
|
Rating |
forumId - Int
|
Forum ID |
topicId - Int
|
Forum Topic ID |
parentId - Int
|
Parent Comment |
authorId - Int
|
Author User ID |
locked - Boolean
|
Parent Comment |
ratingUp - Int
|
Upvote |
ratingDown - Int
|
Downvote |
threadPath - String
|
Thread Sorting String |
bodyText - String
|
Body Reference Text |
body - JSONObject
|
Body Data |
meta - JSONObject
|
Comment Meta Data |
Forum - Forum
|
|
ForumTopic - ForumTopic
|
|
ForumComment - ParentComment
|
|
ForumComments - ChildComment
|
|
User - User
|
Example
{
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"forumId": 987,
"topicId": 123,
"parentId": 987,
"authorId": 987,
"locked": true,
"ratingUp": 987,
"ratingDown": 123,
"threadPath": "abc123",
"bodyText": "xyz789",
"body": {},
"meta": {},
"Forum": Forum,
"ForumTopic": ForumTopic,
"ForumComment": ParentComment,
"ForumComments": ChildComment,
"User": User
}
ForumCommentFilter
Description
Forum Comment Filters
Example
{
"slug": "abc123",
"forumId": 123,
"topicId": 123,
"parentId": 123,
"authorId": 123,
"search": "abc123"
}
ForumCommentNode
Description
Forum Comment Node
Fields
| Field Name | Description |
|---|---|
storage - String
|
Image Storage Location |
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [ForumComment]
|
Example
{
"storage": "xyz789",
"totalCount": 123,
"count": 987,
"nodes": [ForumComment]
}
ForumFilter
ForumNode
ForumRecipesSummary
ForumTopic
Description
Forum Topic Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
title - String
|
Item Title |
slug - String
|
Item Type Unique Identifier String |
forumId - Int
|
Forum ID |
authorId - Int
|
Author ID |
locked - Boolean
|
Forum Topics are Locked |
pinned - Boolean
|
Pinned Forum Topic |
comments - Int
|
Comments Count |
views - Int
|
Views Count |
rating - Int
|
Rating |
ratingUp - Int
|
Upvote |
ratingDown - Int
|
Downvote |
bodyText - String
|
Body Reference Text |
body - JSONObject
|
Body Data |
lastActivityAt - DateTime
|
Last forum activity |
meta - JSONObject
|
Topic Meta Data |
Forum - Forum
|
|
ForumComment - ForumComment
|
|
User - User
|
Example
{
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"slug": "abc123",
"forumId": 987,
"authorId": 987,
"locked": false,
"pinned": true,
"comments": 987,
"views": 987,
"rating": 123,
"ratingUp": 123,
"ratingDown": 123,
"bodyText": "xyz789",
"body": {},
"lastActivityAt": "2007-12-03T10:15:30Z",
"meta": {},
"Forum": Forum,
"ForumComment": ForumComment,
"User": User
}
ForumTopicFilter
ForumTopicNode
Description
Forum Topic Node
Fields
| Field Name | Description |
|---|---|
storage - String
|
Image Storage Location |
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [ForumTopic]
|
Example
{
"storage": "abc123",
"totalCount": 987,
"count": 123,
"nodes": [ForumTopic]
}
Ingredient
Description
Ingredient definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
active - Boolean
|
Ingredient Activity |
ingredientTypeId - Int
|
Ingredient Type Identifier |
vendorId - Int
|
Vendor Unique Identifier |
density - Float
|
Specific Gravity |
code - String
|
Abbreviated Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
name - String
|
Identifier or Title |
slug - String
|
Item Type Unique Identifier String |
description - String
|
Item Description |
image - String
|
Image Name with Extension |
discontinued - Boolean
|
|
IngredientActive - [IngredientActiveIngredientDef]
|
|
IngredientBase - [IngredientBaseIngredientDef]
|
|
IngredientStash - IngredientStash
|
|
IngredientType - IngredientType
|
|
isStashed - Boolean
|
Is in Ingredient Stash |
stashes - Int
|
Ingredient Stashes Count |
Vendor - Vendor
|
|
IngredientTag - [IngredientTag]
|
Example
{
"id": 123,
"active": false,
"ingredientTypeId": 987,
"vendorId": 123,
"density": 123.45,
"code": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"slug": "xyz789",
"description": "abc123",
"image": "xyz789",
"discontinued": false,
"IngredientActive": [IngredientActiveIngredientDef],
"IngredientBase": [IngredientBaseIngredientDef],
"IngredientStash": IngredientStash,
"IngredientType": IngredientType,
"isStashed": true,
"stashes": 987,
"Vendor": Vendor,
"IngredientTag": [IngredientTag]
}
IngredientActiveIngredientDef
Description
Ingredient Active Ingredient definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
active - Boolean
|
Ingredient Activity |
ingredientTypeId - Int
|
Ingredient Type Identifier |
vendorId - Int
|
Vendor Unique Identifier |
density - Float
|
Specific Gravity |
code - String
|
Abbreviated Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
name - String
|
Identifier or Title |
slug - String
|
Item Type Unique Identifier String |
description - String
|
Item Description |
image - String
|
Image Name with Extension |
discontinued - Boolean
|
|
milliactivity - Int
|
Sub-ingredient Milliactivity |
activity - Float
|
Sub-ingredient Activity |
Example
{
"id": 123,
"active": true,
"ingredientTypeId": 123,
"vendorId": 987,
"density": 123.45,
"code": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"slug": "abc123",
"description": "abc123",
"image": "abc123",
"discontinued": true,
"milliactivity": 987,
"activity": 123.45
}
IngredientBaseIngredientDef
Description
Ingredient Base Ingredient definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
active - Boolean
|
Ingredient Activity |
ingredientTypeId - Int
|
Ingredient Type Identifier |
vendorId - Int
|
Vendor Unique Identifier |
density - Float
|
Specific Gravity |
code - String
|
Abbreviated Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
name - String
|
Identifier or Title |
slug - String
|
Item Type Unique Identifier String |
description - String
|
Item Description |
image - String
|
Image Name with Extension |
discontinued - Boolean
|
|
millipercent - Int
|
Sub-ingredient Millipercent |
percent - Float
|
Sub-ingredient Percent |
Example
{
"id": 123,
"active": true,
"ingredientTypeId": 123,
"vendorId": 123,
"density": 987.65,
"code": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"slug": "abc123",
"description": "abc123",
"image": "abc123",
"discontinued": true,
"millipercent": 987,
"percent": 987.65
}
IngredientFilter
Description
Ingredient Filters
Example
{
"ingredientTypeId": 123,
"active": true,
"vendorId": 123,
"search": "xyz789",
"excludeIds": [123],
"isStashed": false,
"tag": TagTypeFilter
}
IngredientNode
Description
Ingredient Node
Fields
| Field Name | Description |
|---|---|
totalCount - Int
|
|
count - Int
|
|
nodes - [Ingredient]
|
Example
{"totalCount": 123, "count": 987, "nodes": [Ingredient]}
IngredientStash
Description
Ingredient Stash definition
Fields
| Field Name | Description |
|---|---|
userId - Int
|
User Unique Identifier |
ingredientId - Int
|
Ingredient Type Identifier |
isStashed - Boolean
|
Is in Stash |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
stockLevel - Float
|
Total ingredient amount on hold |
cost - Float
|
Ingredient cost |
volume - Float
|
Ingredient bottle size |
costPerML - Float
|
Ingredient cost for calculations |
location - String
|
Ingredient location |
meta - JSONObject
|
Ingredient Data |
density - Int
|
Density Override |
Ingredient - Ingredient
|
|
User - User
|
Example
{
"userId": 987,
"ingredientId": 123,
"isStashed": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"stockLevel": 987.65,
"cost": 987.65,
"volume": 123.45,
"costPerML": 123.45,
"location": "abc123",
"meta": {},
"density": 123,
"Ingredient": Ingredient,
"User": User
}
IngredientStashFilter
Description
Ingredient Stash Filters
Example
{
"vendorId": 123,
"search": "abc123",
"isStashed": false,
"ingredientId": 123,
"userId": 987,
"username": "xyz789"
}
IngredientStashNode
Description
Ingredient Stash Node
Fields
| Field Name | Description |
|---|---|
storage - String
|
Image Storage Location |
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [IngredientStash]
|
Example
{
"storage": "abc123",
"totalCount": 123,
"count": 987,
"nodes": [IngredientStash]
}
IngredientTag
Description
Ingredient Tag definition
Fields
| Field Name | Description |
|---|---|
ingredientId - Int
|
Ingredient Type Identifier |
tagId - Int
|
Tag ID |
userId - Int
|
User Unique Identifier |
active - Boolean
|
Ingredient Activity |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
weight - Int
|
Tag Prominence |
rating - Int
|
Rating |
meta - JSONObject
|
Meta Data |
Ingredient - Ingredient
|
|
Tag - Tag
|
|
User - User
|
Example
{
"ingredientId": 987,
"tagId": 123,
"userId": 987,
"active": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"weight": 987,
"rating": 123,
"meta": {},
"Ingredient": Ingredient,
"Tag": Tag,
"User": User
}
IngredientType
IngredientTypeFilter
Description
Ingredient Type Filters
Fields
| Input Field | Description |
|---|---|
search - String
|
Example
{"search": "abc123"}
IngredientTypeNode
Description
Ingredient Type Node
Fields
| Field Name | Description |
|---|---|
totalCount - Int
|
|
count - Int
|
|
nodes - [IngredientType]
|
Example
{
"totalCount": 987,
"count": 123,
"nodes": [IngredientType]
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
ItemAction
Description
Item Action definition
Example
{
"id": 123,
"name": "xyz789",
"slug": "abc123",
"action": "abc123",
"description": "xyz789"
}
ItemType
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
JSONObject
Description
The JSONObject scalar type represents JSON objects as specified by ECMA-404.
Example
{}
License
Description
License definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
name - String
|
Identifier or Title |
url - String
|
Website Address |
recipes - Int
|
Recipes |
imageUrl - String
|
URL to the Image |
adaptable - Boolean
|
License allows adaptation |
attribution - Boolean
|
License requires attribution |
commercial - Boolean
|
License allows commercial use |
recipesCount - Int
|
Number of recipes using this License |
licenseType - String
|
License type |
explanation - String
|
License explanation |
Example
{
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"url": "abc123",
"recipes": 987,
"imageUrl": "abc123",
"adaptable": false,
"attribution": true,
"commercial": true,
"recipesCount": 123,
"licenseType": "abc123",
"explanation": "xyz789"
}
ListFlavor
Description
ListFlavor definition
Fields
| Field Name | Description |
|---|---|
flavorListId - Int
|
Flavor List Unique Id |
flavorId - Int
|
Flavor Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
FlavorList - FlavorList
|
|
Flavor - Flavor
|
Example
{
"flavorListId": 987,
"flavorId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"FlavorList": FlavorList,
"Flavor": Flavor
}
LoginResult
LoginUser
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
username - String
|
Unique Username |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
email - String
|
Email address for user |
banned - Boolean
|
Is Banned |
bannedAt - DateTime
|
Date banned |
bannedEnd - DateTime
|
Date unbanned |
bannedReason - String
|
Last Reason to be Banned |
bannedByUserId - Int
|
Last User to Ban this User |
confirmedAt - DateTime
|
Date User Confirmed |
currentLoginDate - DateTime
|
Date of last login |
logins - Int
|
Number of logins |
prevLoginDate - DateTime
|
Date of previous login |
resetAt - DateTime
|
Date User Password Reset |
token - String
|
|
session - String
|
Example
{
"id": 123,
"username": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "xyz789",
"banned": true,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "abc123",
"bannedByUserId": 123,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 987,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z",
"token": "xyz789",
"session": "abc123"
}
Message
Description
Message definition
Example
{
"id": 987,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"body": "xyz789",
"threadId": 123,
"User": User
}
MessageCounts
MessageFilter
MessageNode
Description
Message Node
Fields
| Field Name | Description |
|---|---|
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
isArchived - Boolean
|
|
nodes - [MessageUser]
|
Example
{
"totalCount": 987,
"count": 123,
"isArchived": false,
"nodes": [MessageUser]
}
MessageThread
Description
Message Threaddefinition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
archived - Boolean
|
Message Thread is archived |
locked - Boolean
|
Message Thread is locked |
subject - String
|
Message Thread subject |
support - Boolean
|
Message Thread is Support Message |
report - Boolean
|
Message Thread is a Report |
ticketId - Int
|
Support request or Report ticket Unique Identifier |
MessageUser - [MessageUser]
|
List of Users in a Message Thread |
Message - [Message]
|
|
Ticket - Ticket
|
Support or Reporting Ticket |
User - User
|
Example
{
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"archived": false,
"locked": true,
"subject": "abc123",
"support": false,
"report": true,
"ticketId": 123,
"MessageUser": [MessageUser],
"Message": [Message],
"Ticket": Ticket,
"User": User
}
MessageToUserList
Description
Send to user(s) definition
Fields
| Input Field | Description |
|---|---|
id - Int
|
Example
{"id": 987}
MessageUser
Description
Message User definition
Fields
| Field Name | Description |
|---|---|
userId - Int
|
User Unique Identifier |
threadId - Int
|
Message Thread Unique ID |
read - Boolean
|
Message Thread read by this User |
MessageThread - MessageThread
|
|
User - User
|
Message User |
Example
{
"userId": 123,
"threadId": 123,
"read": false,
"MessageThread": MessageThread,
"User": User
}
MixerReview
Description
Mixer Review Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
rating - Float
|
Rating |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
title - String
|
Item Title |
body - String
|
Text Body |
mixerId - Int
|
Mixer User Id |
User - User
|
|
Mixer - User
|
Example
{
"id": 987,
"userId": 123,
"rating": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"body": "abc123",
"mixerId": 123,
"User": User,
"Mixer": User
}
ParentComment
Description
Parent Comment Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
rating - Float
|
Rating |
forumId - Int
|
Forum ID |
topicId - Int
|
Forum Topic ID |
parentId - Int
|
Parent Comment |
authorId - Int
|
Author User ID |
locked - Boolean
|
Parent Comment |
ratingUp - Int
|
Upvote |
ratingDown - Int
|
Downvote |
threadPath - String
|
Thread Sorting String |
bodyText - String
|
Body Reference Text |
body - JSONObject
|
Body Data |
meta - JSONObject
|
Comment Meta Data |
Example
{
"id": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"forumId": 123,
"topicId": 987,
"parentId": 123,
"authorId": 123,
"locked": true,
"ratingUp": 123,
"ratingDown": 123,
"threadPath": "xyz789",
"bodyText": "xyz789",
"body": {},
"meta": {}
}
ParentForum
Description
Parent Forum Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
title - String
|
Item Title |
slug - String
|
Item Type Unique Identifier String |
description - String
|
Item Description |
image - String
|
Image Name with Extension |
parentId - Int
|
Parent Forum |
allowTopics - Boolean
|
Allowed to have topics or acts as a container |
externalData - Boolean
|
Uses data schema outside of Forum schema |
locked - Boolean
|
Forum Topics are Locked |
topics - Int
|
Topics Count |
comments - Int
|
Comments Count |
itemTypeId - Int
|
Item Type |
lastActivityAt - DateTime
|
Last forum activity |
rating - Int
|
Rating |
ratingUp - Int
|
Upvote |
ratingDown - Int
|
Downvote |
dataSchema - String
|
External data schema |
meta - JSONObject
|
Forum Meta Data |
Example
{
"id": 123,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"slug": "xyz789",
"description": "xyz789",
"image": "xyz789",
"parentId": 123,
"allowTopics": true,
"externalData": false,
"locked": false,
"topics": 123,
"comments": 987,
"itemTypeId": 123,
"lastActivityAt": "2007-12-03T10:15:30Z",
"rating": 123,
"ratingUp": 123,
"ratingDown": 987,
"dataSchema": "abc123",
"meta": {}
}
Recipe
Description
Recipe definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
isPublished - Boolean
|
Is visible to all users |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
deletedAt - DateTime
|
Date and Time Deleted |
updatedAt - DateTime
|
Date and Time of Last Update |
rating - Float
|
Rating |
ratings - Int
|
Rating Count |
name - String
|
Identifier or Title |
image - String
|
Image Name with Extension |
shareKey - String
|
Recipe share key |
slug - String
|
Item Type Unique Identifier String |
description - String
|
Item Description |
favorites - Int
|
Total Favorited Count |
steepDays - Int
|
Conditioning time in days |
color - String
|
Pattern color override |
isShared - Boolean
|
Recipe is shared |
isOriginal - Boolean
|
Recipe is original |
isInProgress - Boolean
|
Recipe is in progress |
isMTL - Boolean
|
Recipe is mouth to lung |
isSNV - Boolean
|
Recipe is shake and vape |
licenseId - Int
|
Recipe License ID |
revisions - Int
|
Recipe revisions count |
adaptedId - Int
|
Recipe based on Recipe ID |
flavors - Int
|
Recipe Flavors count |
mixes - Int
|
Recipe Mixes count |
notes - JSON
|
Recipe notes |
publishedAt - DateTime
|
Recipe published date |
restricted - Boolean
|
Recipe contains Restricted content |
restrictedAt - DateTime
|
Recipe restricted date |
restrictedReason - String
|
Recipe restricted reason |
totalMillipercent - Float
|
Total flavoring millipercentage |
views - Int
|
Recipe Views count |
comments - Int
|
Recipe Comments count |
imageUrl - String
|
URL to the Image |
imageThumb - String
|
Image Thumbnail |
isFavorite - Boolean
|
Recipe is Favorite |
recipeShare - JSONObject
|
Recipe Share Perms |
flavorCount - Int
|
Flavors in Recipes? |
totalPercent - Float
|
Total Flavor Percent |
License - License
|
License |
RecipeBadge - [BadgeAssignedToItem]
|
|
RecipeFlavor - [RecipeFlavor]
|
Flavors Assigned |
User - User
|
User |
AdaptedRecipe - SimpleRecipe
|
Source Recipe |
RecipeTag - [RecipeTag]
|
Example
{
"id": 123,
"isPublished": true,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"ratings": 987,
"name": "abc123",
"image": "abc123",
"shareKey": "abc123",
"slug": "abc123",
"description": "xyz789",
"favorites": 123,
"steepDays": 123,
"color": "xyz789",
"isShared": false,
"isOriginal": false,
"isInProgress": false,
"isMTL": true,
"isSNV": true,
"licenseId": 123,
"revisions": 987,
"adaptedId": 987,
"flavors": 123,
"mixes": 123,
"notes": {},
"publishedAt": "2007-12-03T10:15:30Z",
"restricted": false,
"restrictedAt": "2007-12-03T10:15:30Z",
"restrictedReason": "abc123",
"totalMillipercent": 123.45,
"views": 987,
"comments": 987,
"imageUrl": "xyz789",
"imageThumb": "xyz789",
"isFavorite": false,
"recipeShare": {},
"flavorCount": 987,
"totalPercent": 123.45,
"License": License,
"RecipeBadge": [BadgeAssignedToItem],
"RecipeFlavor": [RecipeFlavor],
"User": User,
"AdaptedRecipe": SimpleRecipe,
"RecipeTag": [RecipeTag]
}
RecipeComment
Description
Recipe Comment Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
recipeId - Int
|
Recipe ID |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
title - String
|
Item Title |
rating - Float
|
Rating |
locked - Boolean
|
Parent Comment |
parentId - Int
|
Parent Comment |
authorId - Int
|
Author User ID |
ratingUp - Int
|
Upvote |
ratingDown - Int
|
Downvote |
threadPath - String
|
Thread Sorting String |
bodyText - String
|
Body Reference Text |
body - JSONObject
|
Body Data |
meta - JSONObject
|
Comment Meta Data |
Recipe - SimpleRecipe
|
|
User - User
|
Example
{
"id": 987,
"recipeId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "abc123",
"rating": 123.45,
"locked": false,
"parentId": 123,
"authorId": 123,
"ratingUp": 987,
"ratingDown": 123,
"threadPath": "xyz789",
"bodyText": "xyz789",
"body": {},
"meta": {},
"Recipe": SimpleRecipe,
"User": User
}
RecipeCommentFilter
RecipeCommentNode
Description
Recipe Comment Node
Fields
| Field Name | Description |
|---|---|
storage - String
|
Image Storage Location |
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [RecipeComment]
|
Example
{
"storage": "abc123",
"totalCount": 123,
"count": 123,
"nodes": [RecipeComment]
}
RecipeConditioningFilter
RecipeCreateFilter
RecipeFilter
Description
Recipe Filters
Fields
| Input Field | Description |
|---|---|
flavorId - Int
|
Flavor Unique Identifier |
search - String
|
Query String |
userId - Int
|
User Unique Identifier |
deleted - Boolean
|
Recipe is deleted - must be used in conjunction with current user's ID in userId filter |
formulationId - Int
|
Formulations using this Recipe |
flavors - [Int]
|
Filter recipes by multiple Flavor ids |
isClone - Boolean
|
Cloned Recipes |
isComplete - Boolean
|
Show Completed Recipes |
isFavorite - Boolean
|
Favorite Recipes |
isInProgress - Boolean
|
Show In Progress Recipes |
isOriginal - Boolean
|
Show Original Recipes |
isPublished - Boolean
|
Show Published Recipes |
isUnpublished - Boolean
|
Show Unpublished Recipes |
isShared - Boolean
|
Show Shared Recipes |
canMake - RecipeStashFilter
|
|
hasRecommended - Boolean
|
Recipe has a recommended formulation |
hasRequests - Boolean
|
Recipe has requested flavor shots |
hasForSale - Boolean
|
Recipe has batches for sale |
rating - RecipeRatingFilter
|
|
createDate - RecipeCreateFilter
|
|
conditioning - RecipeConditioningFilter
|
|
admin - Boolean
|
Administrative |
noRestricted - Boolean
|
No Restricted Recipes |
userShare - Boolean
|
User Shared Recipes |
tag - TagTypeFilter
|
Tag Filters |
statRange - String
|
Special stat range filter for trending sort only |
Example
{
"flavorId": 987,
"search": "abc123",
"userId": 123,
"deleted": true,
"formulationId": 123,
"flavors": [987],
"isClone": false,
"isComplete": false,
"isFavorite": false,
"isInProgress": false,
"isOriginal": false,
"isPublished": true,
"isUnpublished": true,
"isShared": false,
"canMake": RecipeStashFilter,
"hasRecommended": false,
"hasRequests": false,
"hasForSale": true,
"rating": RecipeRatingFilter,
"createDate": RecipeCreateFilter,
"conditioning": RecipeConditioningFilter,
"admin": true,
"noRestricted": false,
"userShare": false,
"tag": TagTypeFilter,
"statRange": "abc123"
}
RecipeFlavor
Description
Recipe Flavor definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
recipeId - Int
|
Recipe ID |
flavorId - Int
|
Flavor Unique Identifier |
millipercent - Int
|
Percent x 1000 | Allows percentages to be defined without decimals |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
percent - Float
|
Flavor Percent |
Flavor - Flavor
|
Flavor |
Example
{
"id": 123,
"recipeId": 987,
"flavorId": 123,
"millipercent": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"percent": 987.65,
"Flavor": Flavor
}
RecipeFlavorList
Description
Recipe Flavor input multiple fields
Fields
| Input Field | Description |
|---|---|
id - Int
|
Unique Identifier |
recipeId - Int
|
Recipe ID |
flavorId - Int
|
Flavor Unique Identifier |
millipercent - Int
|
Percent x 1000 | Allows percentages to be defined without decimals |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
percent - Float
|
Flavor Percent |
Example
{
"id": 123,
"recipeId": 987,
"flavorId": 987,
"millipercent": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"percent": 123.45
}
RecipeFormulation
Description
Recipe Formulation Type definition
Fields
| Field Name | Description |
|---|---|
recipeId - Int
|
Recipe ID |
formulationId - Int
|
Formulation Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
recCount - Int
|
Number of times combination has been recommended |
recUsers - JSON
|
JSON Array of users who have recommended recipe/formulation combo |
Recipe - SimpleRecipe
|
Simple Recipe Object |
Formulation - Formulation
|
Formulation Object |
Example
{
"recipeId": 123,
"formulationId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"recCount": 987,
"recUsers": {},
"Recipe": SimpleRecipe,
"Formulation": Formulation
}
RecipeFormulationFilter
RecipeFormulationInput
RecipeFormulationNode
Description
Recipe Formulation Node
Fields
| Field Name | Description |
|---|---|
storage - String
|
Image Storage Location |
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [RecipeFormulation]
|
Recipe Formulation List |
Example
{
"storage": "xyz789",
"totalCount": 987,
"count": 123,
"nodes": [RecipeFormulation]
}
RecipeNode
RecipeRatingFilter
RecipeReview
Description
Recipe Review Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
recipeId - Int
|
Recipe ID |
formulationId - Int
|
Formulation Unique Identifier |
userId - Int
|
User Unique Identifier |
rating - Float
|
Rating |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
title - String
|
Item Title |
body - String
|
Text Body |
User - User
|
|
Recipe - SimpleRecipe
|
|
Formulation - Formulation
|
Example
{
"id": 123,
"recipeId": 987,
"formulationId": 987,
"userId": 987,
"rating": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"body": "abc123",
"User": User,
"Recipe": SimpleRecipe,
"Formulation": Formulation
}
RecipeStashFilter
Description
Recipe Filter against User Flavor Stash
Fields
| Input Field | Description |
|---|---|
extraFlavors - Int
|
How many flavors can be not stashed (0, 1, or 2) |
Example
{"extraFlavors": 123}
RecipeStatDef
Description
Recipe Stats definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
recipeId - Int
|
Recipe ID |
begins - DateTime
|
Stats Start Range |
ends - DateTime
|
Stats End Range |
comments - Int
|
Comments in Timeframe |
favorites - Int
|
Favorites in Timeframe |
mixes - Int
|
Mixes in Timeframe |
ratings - Int
|
Ratings in Timeframe |
views - Int
|
Views in Timeframe |
type - String
|
Stats Type |
unit - String
|
Stats Range Unit |
Example
{
"id": 987,
"recipeId": 123,
"begins": "2007-12-03T10:15:30Z",
"ends": "2007-12-03T10:15:30Z",
"comments": 123,
"favorites": 123,
"mixes": 987,
"ratings": 123,
"views": 987,
"type": "xyz789",
"unit": "abc123"
}
RecipeStatNode
Description
Recipe Stats Node
Fields
| Field Name | Description |
|---|---|
nodes - [RecipeStatDef]
|
Recipe Stats |
Example
{"nodes": [RecipeStatDef]}
RecipeStatTopDef
Description
Top Recipes definition
Fields
| Field Name | Description |
|---|---|
Recipe - Recipe
|
Top Recipes |
Example
{"Recipe": Recipe}
RecipeStatTopNode
Description
Top Recipes Node
Fields
| Field Name | Description |
|---|---|
nodes - [RecipeStatTopDef]
|
Top Recipe List |
Example
{"nodes": [RecipeStatTopDef]}
RecipeTag
Description
Recipe Tag definition
Fields
| Field Name | Description |
|---|---|
recipeId - Int
|
Recipe ID |
tagId - Int
|
Tag ID |
userId - Int
|
User Unique Identifier |
active - Boolean
|
Ingredient Activity |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
weight - Int
|
Tag Prominence |
rating - Int
|
Rating |
meta - JSONObject
|
Meta Data |
Recipe - SimpleRecipe
|
|
Tag - Tag
|
|
User - User
|
Example
{
"recipeId": 987,
"tagId": 123,
"userId": 123,
"active": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"weight": 123,
"rating": 123,
"meta": {},
"Recipe": SimpleRecipe,
"Tag": Tag,
"User": User
}
RemoveRecipe
Description
Remove a Recipe Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
isPublished - Boolean
|
Is visible to all users |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
deletedAt - DateTime
|
Date and Time Deleted |
updatedAt - DateTime
|
Date and Time of Last Update |
rating - Float
|
Rating |
ratings - Int
|
Rating Count |
name - String
|
Identifier or Title |
image - String
|
Image Name with Extension |
shareKey - String
|
Recipe share key |
slug - String
|
Item Type Unique Identifier String |
description - String
|
Item Description |
favorites - Int
|
Total Favorited Count |
steepDays - Int
|
Conditioning time in days |
color - String
|
Pattern color override |
isShared - Boolean
|
Recipe is shared |
isOriginal - Boolean
|
Recipe is original |
isInProgress - Boolean
|
Recipe is in progress |
isMTL - Boolean
|
Recipe is mouth to lung |
isSNV - Boolean
|
Recipe is shake and vape |
licenseId - Int
|
Recipe License ID |
revisions - Int
|
Recipe revisions count |
adaptedId - Int
|
Recipe based on Recipe ID |
flavors - Int
|
Recipe Flavors count |
mixes - Int
|
Recipe Mixes count |
notes - JSON
|
Recipe notes |
publishedAt - DateTime
|
Recipe published date |
restricted - Boolean
|
Recipe contains Restricted content |
restrictedAt - DateTime
|
Recipe restricted date |
restrictedReason - String
|
Recipe restricted reason |
totalMillipercent - Float
|
Total flavoring millipercentage |
views - Int
|
Recipe Views count |
comments - Int
|
Recipe Comments count |
Example
{
"id": 987,
"isPublished": true,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"ratings": 123,
"name": "abc123",
"image": "xyz789",
"shareKey": "abc123",
"slug": "xyz789",
"description": "abc123",
"favorites": 123,
"steepDays": 987,
"color": "abc123",
"isShared": false,
"isOriginal": true,
"isInProgress": true,
"isMTL": false,
"isSNV": false,
"licenseId": 987,
"revisions": 987,
"adaptedId": 123,
"flavors": 987,
"mixes": 987,
"notes": {},
"publishedAt": "2007-12-03T10:15:30Z",
"restricted": true,
"restrictedAt": "2007-12-03T10:15:30Z",
"restrictedReason": "abc123",
"totalMillipercent": 123.45,
"views": 123,
"comments": 987
}
RequestUserReset
RequestedFlavorMatch
Description
Flavor Requested for Matching
Example
{
"name": "xyz789",
"percent": 123.45,
"percentage": 123.45,
"vendor": "xyz789"
}
RetailFlavor
Description
Vendor Flavor definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
flavorId - Int
|
Flavor Unique Identifier |
slug - String
|
Item Type Unique Identifier String |
retailVendorId - Int
|
Flavor Vendor ID |
sellerId - Int
|
Seller Vendor ID |
active - Boolean
|
Is actively stocked |
inStock - Boolean
|
Flavor In Stock |
clicks - Int
|
Referral Clicks Count |
meta - JSONObject
|
RetailFlavor Flavor Meta Data |
Flavor - Flavor
|
|
Vendor - Vendor
|
Example
{
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"flavorId": 987,
"slug": "xyz789",
"retailVendorId": 123,
"sellerId": 987,
"active": false,
"inStock": false,
"clicks": 987,
"meta": {},
"Flavor": Flavor,
"Vendor": Vendor
}
RetailFlavorFilter
Description
Vendor Flavor Filters
Fields
| Input Field | Description |
|---|---|
recipes - FlavorFilterRecipes
|
Flavor Filter by Recipe Count |
sellerId - Int
|
|
vendorId - Int
|
|
search - String
|
|
vendors - [Int]
|
Flavor Filter by List of Vendor Unique Identifiers |
Example
{
"recipes": FlavorFilterRecipes,
"sellerId": 987,
"vendorId": 987,
"search": "xyz789",
"vendors": [987]
}
RetailVendor
Description
Vendor Flavor definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
vendorId - Int
|
Vendor Unique Identifier |
slug - String
|
Item Type Unique Identifier String |
active - Boolean
|
Retail Currently Carries Vendor ID |
sellerId - Int
|
Retail Seller's Vendor ID |
flavorUrlPattern - String
|
Flavor Slug Matching Pattern |
ingredientUrlPattern - String
|
Ingredient Slug Matching Pattern |
clicks - Int
|
Referral Clicks Count |
meta - JSONObject
|
RetailVendor Flavor Meta Data |
Flavor - Flavor
|
|
Vendor_RetailVendor_sellerIdToVendor - Vendor
|
|
Vendor_RetailVendor_vendorIdToVendor - Vendor
|
Example
{
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"vendorId": 123,
"slug": "xyz789",
"active": true,
"sellerId": 987,
"flavorUrlPattern": "xyz789",
"ingredientUrlPattern": "abc123",
"clicks": 987,
"meta": {},
"Flavor": Flavor,
"Vendor_RetailVendor_sellerIdToVendor": Vendor,
"Vendor_RetailVendor_vendorIdToVendor": Vendor
}
RetailVendorFilter
RetailVendorNode
Description
Vendor Flavor Node
Fields
| Field Name | Description |
|---|---|
storage - String
|
Image Storage Location |
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [RetailVendor]
|
Vendor Flavor List |
Example
{
"storage": "abc123",
"totalCount": 987,
"count": 987,
"nodes": [RetailVendor]
}
Review
Description
Common Review Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
rating - Float
|
Rating |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
title - String
|
Item Title |
body - String
|
Text Body |
User - User
|
Possible Types
| Review Types |
|---|
Example
{
"id": 123,
"userId": 987,
"rating": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"body": "abc123",
"User": User
}
ReviewFilter
Description
Review Filters
Example
{
"slug": "xyz789",
"flavorId": 123,
"recipeId": 987,
"vendorId": 123,
"userId": 987,
"mixerId": 123,
"mixername": "abc123"
}
ReviewNode
Description
Review Node
Example
{
"averageRating": 987.65,
"storage": "abc123",
"totalCount": 987,
"count": 987,
"nodes": [Review]
}
Role
RoleNode
RolePermission
Description
Role Permission definition
Fields
| Field Name | Description |
|---|---|
roleId - Int
|
Role Unique Identifier |
permissionSubjectId - Int
|
Item Type Unique Identifier |
permissionActionId - Int
|
Permission Action Unique Identifier |
inverted - Boolean
|
Permission is Inverted - for Cannot |
conditions - JSON
|
Permission Conditions |
reason - String
|
Reason Permission Applies |
ItemType - ItemType
|
|
ItemAction - ItemAction
|
|
Role - Role
|
Example
{
"roleId": 987,
"permissionSubjectId": 123,
"permissionActionId": 987,
"inverted": false,
"conditions": {},
"reason": "xyz789",
"ItemType": ItemType,
"ItemAction": ItemAction,
"Role": Role
}
RolePermissionFilter
Description
Role Permission Filters
Example
{
"action": "xyz789",
"search": "xyz789",
"inverted": false,
"permissionActionId": 987,
"permissionSubjectId": 123,
"roleId": 123,
"subject": "abc123"
}
RolePermissionNode
Description
Role Permissions List
Fields
| Field Name | Description |
|---|---|
storage - Int
|
|
totalCount - Int
|
|
count - Int
|
|
nodes - [RolePermission]
|
Role Permissions List |
Example
{
"storage": 987,
"totalCount": 987,
"count": 123,
"nodes": [RolePermission]
}
SaleBatch
Description
Sale Batch Batch definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
recipeId - Int
|
Recipe ID |
createdAt - DateTime
|
Date and Time Created |
name - String
|
Identifier or Title |
batchSize - Float
|
Size of the Batch |
amountRemaining - Float
|
Remaining Amount of the Batch |
version - String
|
All the Flavors Version |
lot - String
|
Batch Lot Identifier |
data - JSON
|
Batch Calculator Data |
desiredMixingPercent - Float
|
Percent to add a Flavor Shot at. Null if different type of batch |
isForSale - Boolean
|
Batch is available for sale |
wasSold - Boolean
|
Batch was ever available for sale |
Recipe - SimpleRecipe
|
|
User - User
|
Example
{
"id": 123,
"userId": 987,
"recipeId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"batchSize": 987.65,
"amountRemaining": 123.45,
"version": "xyz789",
"lot": "xyz789",
"data": {},
"desiredMixingPercent": 987.65,
"isForSale": true,
"wasSold": true,
"Recipe": SimpleRecipe,
"User": User
}
SaleBatchNode
Description
Sale Batch Node
Fields
| Field Name | Description |
|---|---|
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [SaleBatch]
|
Sale Batches |
Example
{"totalCount": 987, "count": 123, "nodes": [SaleBatch]}
ServerStatus
Description
Server Status definition
Fields
| Field Name | Description |
|---|---|
status - String
|
Example
{"status": "xyz789"}
Session
Description
Session definition
Fields
| Field Name | Description |
|---|---|
id - UUID
|
Session id, uuid v4 |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
revoked - Boolean
|
Session is revoked and unusable |
exp - DateTime
|
Session Expiration |
identifier - String
|
Session Unique Hash |
userAgent - String
|
Session User Agent |
ip - String
|
Session IP Address |
data - JSONObject
|
Session Data |
Example
{
"id": "929d661d-04a9-4ad3-b396-1dc92733af12",
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"revoked": false,
"exp": "2007-12-03T10:15:30Z",
"identifier": "abc123",
"userAgent": "xyz789",
"ip": "xyz789",
"data": {}
}
SimpleRecipe
Description
Simple Recipe definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
slug - String
|
Item Type Unique Identifier String |
shareKey - String
|
Recipe share key |
name - String
|
Identifier or Title |
color - String
|
Pattern color override |
userId - Int
|
User Unique Identifier |
isPublished - Boolean
|
Is visible to all users |
isShared - Boolean
|
Recipe is shared |
deletedAt - DateTime
|
Date and Time Deleted |
totalMillipercent - Float
|
Total flavoring millipercentage |
isFavorite - Boolean
|
Recipe is Favorite |
recipeShare - JSONObject
|
Recipe Share Perms |
restricted - Boolean
|
Recipe contains Restricted content |
restrictedReason - String
|
Recipe restricted reason |
totalPercent - Float
|
Total Flavor Percent |
steepDays - Int
|
Conditioning time in days |
User - User
|
User |
License - License
|
License |
RecipeTag - [RecipeTag]
|
Example
{
"id": 123,
"slug": "xyz789",
"shareKey": "abc123",
"name": "abc123",
"color": "abc123",
"userId": 123,
"isPublished": true,
"isShared": true,
"deletedAt": "2007-12-03T10:15:30Z",
"totalMillipercent": 123.45,
"isFavorite": true,
"recipeShare": {},
"restricted": false,
"restrictedReason": "abc123",
"totalPercent": 123.45,
"steepDays": 123,
"User": User,
"License": License,
"RecipeTag": [RecipeTag]
}
SimpleRecipeFormulation
Description
Recipe Formulation Create or Update
Fields
| Field Name | Description |
|---|---|
recipeId - Int
|
Recipe ID |
formulationId - Int
|
Formulation Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
recCount - Int
|
Number of times combination has been recommended |
recUsers - JSON
|
JSON Array of users who have recommended recipe/formulation combo |
Example
{
"recipeId": 987,
"formulationId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"recCount": 987,
"recUsers": {}
}
Sort
SortMultiple
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
Tag
Description
Tag definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
parentId - Int
|
Item Parent ID |
active - Boolean
|
Ingredient Activity |
name - String
|
Identifier or Title |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
confirmed - Boolean
|
Tag Confirmed |
aliasId - Int
|
Alias of Tag ID |
tier - Int
|
Tag Hierarchy Level |
path - String
|
Tag Path |
meta - JSONObject
|
Meta Data |
childDepth - Int
|
|
Alias - TagBase
|
|
FlavorTag - FlavorTag
|
|
FormulationTag - FormulationTag
|
|
IngredientTag - IngredientTag
|
|
Parent - TagBase
|
|
RecipeTag - RecipeTag
|
|
Tags - [TagBase]
|
Example
{
"id": 987,
"parentId": 987,
"active": false,
"name": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"confirmed": false,
"aliasId": 123,
"tier": 123,
"path": "xyz789",
"meta": {},
"childDepth": 987,
"Alias": TagBase,
"FlavorTag": FlavorTag,
"FormulationTag": FormulationTag,
"IngredientTag": IngredientTag,
"Parent": TagBase,
"RecipeTag": RecipeTag,
"Tags": [TagBase]
}
TagBase
Description
Tag Base definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
parentId - Int
|
Item Parent ID |
active - Boolean
|
Ingredient Activity |
name - String
|
Identifier or Title |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
confirmed - Boolean
|
Tag Confirmed |
aliasId - Int
|
Alias of Tag ID |
tier - Int
|
Tag Hierarchy Level |
path - String
|
Tag Path |
meta - JSONObject
|
Meta Data |
Example
{
"id": 987,
"parentId": 987,
"active": false,
"name": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"confirmed": true,
"aliasId": 987,
"tier": 987,
"path": "abc123",
"meta": {}
}
TagFilter
Description
Tag Filters
Example
{
"flavorId": 987,
"formulationId": 987,
"ingredientId": 123,
"recipeId": 123,
"search": "abc123",
"tagId": 123,
"type": "abc123",
"userId": 987,
"showInactive": true,
"metaOnly": true,
"isUnconfirmed": true,
"tier": 123
}
TagNode
TagType
Description
Tag Type interface definition
Fields
| Field Name | Description |
|---|---|
active - Boolean
|
Ingredient Activity |
tagId - Int
|
Tag ID |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
userId - Int
|
User Unique Identifier |
weight - Int
|
Tag Prominence |
rating - Int
|
Rating |
meta - JSONObject
|
Meta Data |
Possible Types
| TagType Types |
|---|
Example
{
"active": true,
"tagId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"userId": 987,
"weight": 123,
"rating": 123,
"meta": {}
}
TagTypeFilter
TagTypeInfo
Description
Tag Info Definition
Fields
| Field Name | Description |
|---|---|
tiers - [Int]
|
Tag Tiers |
Example
{"tiers": [987]}
Ticket
Description
Ticket definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
open - Boolean
|
Ticket status |
contact - String
|
Ticket contact info |
info - String
|
Ticket details |
reportFlavorReviewId - Int
|
Ticket is a Report about a Flavor Review |
reportForumCommentId - Int
|
Ticket is a Report about a Forum Comment |
reportForumTopicId - Int
|
Ticket is a Report about a Forum Topic |
reportRecipeId - Int
|
Ticket is a Report about a Recipe |
reportRecipeCommentId - Int
|
Ticket is a Report about a Recipe Comment |
reportRecipeReviewId - Int
|
Ticket is a Report about a Recipe Review |
reportUserId - Int
|
Ticket is a Report about a User |
reportVendorReviewId - Int
|
Ticket is a Report about a Vendor Review |
ForumComment - ForumComment
|
Forum Comment being reported |
ForumTopic - ForumTopic
|
Forum Topic being reported |
Recipe - SimpleRecipe
|
Recipe being reported |
User_Ticket_reportUserIdToUser - User
|
User being reported |
User_Ticket_userIdToUser - User
|
User creating Ticket |
Example
{
"id": 987,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"open": false,
"contact": "abc123",
"info": "xyz789",
"reportFlavorReviewId": 123,
"reportForumCommentId": 987,
"reportForumTopicId": 123,
"reportRecipeId": 123,
"reportRecipeCommentId": 987,
"reportRecipeReviewId": 123,
"reportUserId": 123,
"reportVendorReviewId": 123,
"ForumComment": ForumComment,
"ForumTopic": ForumTopic,
"Recipe": SimpleRecipe,
"User_Ticket_reportUserIdToUser": User,
"User_Ticket_userIdToUser": User
}
TicketInput
Description
CreateTicket
Fields
| Input Field | Description |
|---|---|
id - Int
|
Unique Identifier |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
open - Boolean
|
Ticket status |
contact - String
|
Ticket contact info |
info - String
|
Ticket details |
reportFlavorReviewId - Int
|
Ticket is a Report about a Flavor Review |
reportForumCommentId - Int
|
Ticket is a Report about a Forum Comment |
reportForumTopicId - Int
|
Ticket is a Report about a Forum Topic |
reportRecipeId - Int
|
Ticket is a Report about a Recipe |
reportRecipeCommentId - Int
|
Ticket is a Report about a Recipe Comment |
reportRecipeReviewId - Int
|
Ticket is a Report about a Recipe Review |
reportUserId - Int
|
Ticket is a Report about a User |
reportVendorReviewId - Int
|
Ticket is a Report about a Vendor Review |
Example
{
"id": 987,
"userId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"open": true,
"contact": "abc123",
"info": "xyz789",
"reportFlavorReviewId": 987,
"reportForumCommentId": 987,
"reportForumTopicId": 987,
"reportRecipeId": 123,
"reportRecipeCommentId": 987,
"reportRecipeReviewId": 987,
"reportUserId": 123,
"reportVendorReviewId": 123
}
UUID
Description
A field whose value is a generic Universally Unique Identifier: https://en.wikipedia.org/wiki/Universally_unique_identifier.
Example
"929d661d-04a9-4ad3-b396-1dc92733af12"
UnconfirmedFlavor
Description
Unconfirmed Flavor definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
vendorId - Int
|
Vendor Unique Identifier |
density - Float
|
Specific Gravity |
createdAt - DateTime
|
Date and Time Created |
name - String
|
Identifier or Title |
url - String
|
Website Address |
userId - Int
|
User Unique Identifier |
baseId - Int
|
The base ingredient id of this flavor |
vendorMillipercent - Int
|
Vendor recommended usage millipercent |
Vendor - Vendor
|
|
vendorPercent - Float
|
Vendor recommented use percent |
User - User
|
|
FlavorBase - Ingredient
|
Example
{
"id": 987,
"vendorId": 987,
"density": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"url": "abc123",
"userId": 987,
"baseId": 987,
"vendorMillipercent": 123,
"Vendor": Vendor,
"vendorPercent": 123.45,
"User": User,
"FlavorBase": Ingredient
}
UnconfirmedFlavorNode
Description
Unconfirmed Flavor Node
Fields
| Field Name | Description |
|---|---|
storage - String
|
Image Storage Location |
totalCount - Int
|
Total Number of Rows |
count - Int
|
Number of Rows to Return |
nodes - [UnconfirmedFlavor]
|
Unconfirmed Flavors |
Example
{
"storage": "abc123",
"totalCount": 123,
"count": 123,
"nodes": [UnconfirmedFlavor]
}
UndeleteRecipe
Description
Undelete a Recipe Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
isPublished - Boolean
|
Is visible to all users |
userId - Int
|
User Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
deletedAt - DateTime
|
Date and Time Deleted |
updatedAt - DateTime
|
Date and Time of Last Update |
rating - Float
|
Rating |
ratings - Int
|
Rating Count |
name - String
|
Identifier or Title |
image - String
|
Image Name with Extension |
shareKey - String
|
Recipe share key |
slug - String
|
Item Type Unique Identifier String |
description - String
|
Item Description |
favorites - Int
|
Total Favorited Count |
steepDays - Int
|
Conditioning time in days |
color - String
|
Pattern color override |
isShared - Boolean
|
Recipe is shared |
isOriginal - Boolean
|
Recipe is original |
isInProgress - Boolean
|
Recipe is in progress |
isMTL - Boolean
|
Recipe is mouth to lung |
isSNV - Boolean
|
Recipe is shake and vape |
licenseId - Int
|
Recipe License ID |
revisions - Int
|
Recipe revisions count |
adaptedId - Int
|
Recipe based on Recipe ID |
flavors - Int
|
Recipe Flavors count |
mixes - Int
|
Recipe Mixes count |
notes - JSON
|
Recipe notes |
publishedAt - DateTime
|
Recipe published date |
restricted - Boolean
|
Recipe contains Restricted content |
restrictedAt - DateTime
|
Recipe restricted date |
restrictedReason - String
|
Recipe restricted reason |
totalMillipercent - Float
|
Total flavoring millipercentage |
views - Int
|
Recipe Views count |
comments - Int
|
Recipe Comments count |
Example
{
"id": 987,
"isPublished": false,
"userId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"rating": 987.65,
"ratings": 123,
"name": "abc123",
"image": "xyz789",
"shareKey": "abc123",
"slug": "abc123",
"description": "xyz789",
"favorites": 987,
"steepDays": 123,
"color": "abc123",
"isShared": false,
"isOriginal": false,
"isInProgress": false,
"isMTL": false,
"isSNV": true,
"licenseId": 987,
"revisions": 123,
"adaptedId": 987,
"flavors": 123,
"mixes": 123,
"notes": {},
"publishedAt": "2007-12-03T10:15:30Z",
"restricted": false,
"restrictedAt": "2007-12-03T10:15:30Z",
"restrictedReason": "abc123",
"totalMillipercent": 123.45,
"views": 123,
"comments": 123
}
Upload
UploadedFile
User
Description
User definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
username - String
|
Unique Username |
image - String
|
Image Name with Extension |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
description - String
|
Item Description |
favorites - Int
|
Total Favorited Count |
recipes - Int
|
Recipes |
rating - Float
|
Rating |
ratings - Int
|
Rating Count |
publicRecipes - Int
|
User Public Recipe Count |
flavors - Int
|
Number of Flavors in Flavor Stash |
interests - String
|
User Interests |
location - Int
|
User location |
restricted - Boolean
|
User Profile contains Restricted content |
isFavorite - Boolean
|
Is a Favorite |
imageThumb - String
|
Image Thumbnail |
imageUrl - String
|
URL to the Image |
isFollowing - Boolean
|
Current User is Following this User |
isFollower - Boolean
|
User is Follower of Current User |
followers - Int
|
Number of Followers this User has |
publicInventory - Boolean
|
Stash is Public |
showFollowers - Boolean
|
Followers are Public |
showFollowing - Boolean
|
Followings are Public |
Country - Country
|
|
UserBadge - [BadgeAssignedToItem]
|
|
UserRole - [UserRole]
|
Example
{
"id": 987,
"username": "abc123",
"image": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"favorites": 987,
"recipes": 987,
"rating": 123.45,
"ratings": 987,
"publicRecipes": 987,
"flavors": 987,
"interests": "xyz789",
"location": 987,
"restricted": true,
"isFavorite": false,
"imageThumb": "xyz789",
"imageUrl": "abc123",
"isFollowing": true,
"isFollower": false,
"followers": 987,
"publicInventory": true,
"showFollowers": false,
"showFollowing": true,
"Country": Country,
"UserBadge": [BadgeAssignedToItem],
"UserRole": [UserRole]
}
UserActivate
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
username - String
|
Unique Username |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
email - String
|
Email address for user |
banned - Boolean
|
Is Banned |
bannedAt - DateTime
|
Date banned |
bannedEnd - DateTime
|
Date unbanned |
bannedReason - String
|
Last Reason to be Banned |
bannedByUserId - Int
|
Last User to Ban this User |
confirmedAt - DateTime
|
Date User Confirmed |
currentLoginDate - DateTime
|
Date of last login |
logins - Int
|
Number of logins |
prevLoginDate - DateTime
|
Date of previous login |
resetAt - DateTime
|
Date User Password Reset |
Example
{
"id": 123,
"username": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "xyz789",
"banned": true,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "xyz789",
"bannedByUserId": 987,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 123,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z"
}
UserAdmin
Description
User Administration definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
username - String
|
Unique Username |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
email - String
|
Email address for user |
banned - Boolean
|
Is Banned |
bannedAt - DateTime
|
Date banned |
bannedEnd - DateTime
|
Date unbanned |
bannedReason - String
|
Last Reason to be Banned |
bannedByUserId - Int
|
Last User to Ban this User |
confirmedAt - DateTime
|
Date User Confirmed |
currentLoginDate - DateTime
|
Date of last login |
logins - Int
|
Number of logins |
prevLoginDate - DateTime
|
Date of previous login |
resetAt - DateTime
|
Date User Password Reset |
image - String
|
Image Name with Extension |
description - String
|
Item Description |
favorites - Int
|
Total Favorited Count |
recipes - Int
|
Recipes |
rating - Float
|
Rating |
ratings - Int
|
Rating Count |
publicRecipes - Int
|
User Public Recipe Count |
flavors - Int
|
User Flavor Count |
interests - String
|
User Interests |
location - Int
|
User location |
restricted - Boolean
|
User Profile contains Restricted content |
settings - JSONObject
|
User settings |
imageThumb - String
|
Image Thumbnail |
imageUrl - String
|
URL to the Image |
Session - [Session]
|
Example
{
"id": 987,
"username": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"email": "abc123",
"banned": true,
"bannedAt": "2007-12-03T10:15:30Z",
"bannedEnd": "2007-12-03T10:15:30Z",
"bannedReason": "abc123",
"bannedByUserId": 987,
"confirmedAt": "2007-12-03T10:15:30Z",
"currentLoginDate": "2007-12-03T10:15:30Z",
"logins": 123,
"prevLoginDate": "2007-12-03T10:15:30Z",
"resetAt": "2007-12-03T10:15:30Z",
"image": "xyz789",
"description": "xyz789",
"favorites": 987,
"recipes": 987,
"rating": 123.45,
"ratings": 987,
"publicRecipes": 123,
"flavors": 123,
"interests": "xyz789",
"location": 123,
"restricted": true,
"settings": {},
"imageThumb": "xyz789",
"imageUrl": "abc123",
"Session": [Session]
}
UserFilter
Description
User Filters
Example
{
"favorite": true,
"favoritedMe": false,
"favorites": 123,
"flavors": 987,
"follower": true,
"following": true,
"recipes": 123,
"search": "abc123",
"countries": [123]
}
UserNode
UserPasswordReset
Fields
| Field Name | Description |
|---|---|
reset - Boolean
|
Example
{"reset": false}
UserRole
UserRoleFilter
UserRoleNode
Description
User Roles or Role Users List
Fields
| Field Name | Description |
|---|---|
storage - Int
|
|
totalCount - Int
|
|
count - Int
|
|
nodes - [UserRole]
|
User Roles List |
Example
{
"storage": 987,
"totalCount": 987,
"count": 987,
"nodes": [UserRole]
}
Vendor
Description
Vendor definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
name - String
|
Identifier or Title |
description - String
|
Item Description |
favorites - Int
|
Total Favorited Count |
rating - Float
|
Rating |
ratings - Int
|
Rating Count |
recipes - Int
|
Recipes |
image - String
|
Image Name with Extension |
slug - String
|
Item Type Unique Identifier String |
active - Boolean
|
Is Vendor active |
abbreviation - String
|
Vendor abbreviation |
vendorTypeId - Int
|
Vendor Type ID |
location - Int
|
Country of origin |
couponCode - String
|
Vendor Coupon Code |
referralUrl - String
|
Vendor Partner URL |
referralParam - String
|
Additional Partner URL Parameter |
flavorUrlPattern - String
|
Standardized Match Pattern for Generating Vendor Flavor Referral Slugs |
ingredientUrlPattern - String
|
Standardized Match Pattern for Generating Vendor Ingredient Referral Slugs |
isFavorite - Boolean
|
Is a Favorite |
imageThumb - String
|
Image Thumbnail |
imageUrl - String
|
URL to the Image |
Country - Country
|
|
VendorBadge - [BadgeAssignedToItem]
|
|
VendorType - VendorType
|
|
VendorWebsite - [VendorWebsite]
|
Example
{
"id": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"description": "xyz789",
"favorites": 123,
"rating": 123.45,
"ratings": 987,
"recipes": 987,
"image": "xyz789",
"slug": "xyz789",
"active": true,
"abbreviation": "abc123",
"vendorTypeId": 123,
"location": 123,
"couponCode": "xyz789",
"referralUrl": "abc123",
"referralParam": "xyz789",
"flavorUrlPattern": "xyz789",
"ingredientUrlPattern": "xyz789",
"isFavorite": false,
"imageThumb": "abc123",
"imageUrl": "xyz789",
"Country": Country,
"VendorBadge": [BadgeAssignedToItem],
"VendorType": VendorType,
"VendorWebsite": [VendorWebsite]
}
VendorFilter
VendorNode
VendorReview
Description
Vendor Review Definition
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique Identifier |
vendorId - Int
|
Vendor Unique Identifier |
userId - Int
|
User Unique Identifier |
rating - Float
|
Rating |
createdAt - DateTime
|
Date and Time Created |
updatedAt - DateTime
|
Date and Time of Last Update |
title - String
|
Item Title |
body - String
|
Text Body |
User - User
|
|
Vendor - Vendor
|
Example
{
"id": 987,
"vendorId": 987,
"userId": 987,
"rating": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"title": "xyz789",
"body": "abc123",
"User": User,
"Vendor": Vendor
}
VendorType
VendorWebsite
Description
Vendor Website definition
Example
{
"id": 987,
"vendorId": 987,
"url": "abc123",
"default": false,
"label": "abc123"
}
VendorWebsiteInput
Description
Vendor Website Input
Example
{
"id": 123,
"vendorId": 987,
"url": "xyz789",
"default": false,
"label": "abc123",
"delete": false
}
Void
Description
Represents NULL values