Logo

API Documentation

API docs by Redocly

Account_API (v1)

The Account HTTP API. This API provides capabilities to manage customer profiles and related information as well as a chat interface with 3rd party AI chat services.

Chat

Gets chat conversation history for the authenticated user id.

Responses

Response samples

Content type
No sample

Creates a new chat conversation for the authenticated user.

Request Body schema:

Details of the first message for the conversation.

message
string or null

The initial message of the conversation.

Responses

Request samples

Content type
{
  • "message": "string"
}

Response samples

Content type
No sample

Gets a chat conversation for the authenticated user id.

path Parameters
conversationId
required
string

conversation id requested

Responses

Response samples

Content type
No sample

Creates a new message part of the active conversation for the authenticated user.

path Parameters
conversationId
required
string
Request Body schema:

Details of the message for the active conversation.

message
string or null
conversationId
string or null

Responses

Request samples

Content type
{
  • "message": "string",
  • "conversationId": "string"
}

Response samples

Content type
No sample

Gets chat conversation history for the user id.

path Parameters
userId
required
string

user id for the conversation requested

Responses

Response samples

Content type
No sample

Creates a new chat conversation for the authenticated user.

path Parameters
userId
required
string
Request Body schema:

Details of the first message for the conversation.

userId
string or null
message
string or null

Responses

Request samples

Content type
{
  • "userId": "string",
  • "message": "string"
}

Response samples

Content type
No sample

Gets a chat conversation for the user id.

path Parameters
userId
required
string

user id for the conversation requested

conversationId
required
string

conversation id requested

Responses

Response samples

Content type
No sample

Creates a new message part of the active conversation for the authenticated user.

path Parameters
userId
required
string
conversationId
required
string
Request Body schema:

Details of the message for the active conversation.

userId
string or null
message
string or null
conversationId
string or null

Responses

Request samples

Content type
{
  • "userId": "string",
  • "message": "string",
  • "conversationId": "string"
}

Response samples

Content type
No sample

Customer

Creates a customer for the authenticated user.

Request Body schema:

Details of the customer to create.

gender
string (Gender)
Enum: "Unknown" "Male" "Female"
adults
integer or null <int32>

The number of adults in the household.

children
integer or null <int32>

The number of children in the household.

cookingSkill
string (CookingSkill)
Enum: "Unknown" "Beginner" "Intermediate" "Advanced"
cookingTimeRange
string (CookingTimeRange)
Enum: "Unknown" "VeryQuick" "Quick" "Average" "Long" "VeryLong"
budgetRange
string (BudgetRange)
Enum: "Unknown" "Low" "Average" "High"
unit
string (Unit)
Enum: "Unknown" "Metric" "US"
calorieObjective
integer or null <int32>

The calorie objective for the customer.

diets
Array of strings or null (Diet)
Enum: "Unknown" "Atkins20" "Atkins40" "Atkins100" "AtkinsFriendly" "KetoDiet" "VeganDiet" "VegetarianDiet" "PescatarianDiet" "PaleoStrictDiet" "PaleoFriendlyDiet" "MediterraneanDiet" "DiabeticDiet" "KosherDiet" "HinduDiet" "HalalDiet"

The collection of diets followed by the customer.

allergies
Array of strings or null (Allergy)
Enum: "Unknown" "WheatFree" "DairyFree" "SoyFree" "FishFree" "ShellfishFree" "MolluskFree" "TreeNutFree" "PeanutFree" "EggFree" "AddedSugarFree" "ArtSweetenerFree" "ArtColorFree" "ArtFlavorFree" "GlutenFree" "SulfiteFree" "SesameFree" "MilkFree" "MustardFree"

The collection of allergies the customer has.

intolerances
Array of strings or null (Intolerance)
Enum: "Unknown" "WheatFree" "DairyFree" "SoyFree" "FishFree" "ShellfishFree" "MolluskFree" "TreeNutFree" "PeanutFree" "EggFree" "AddedSugarFree" "ArtSweetenerFree" "ArtColorFree" "ArtFlavorFree" "GlutenFree" "SulfiteFree" "SesameFree" "MilkFree" "MustardFree"

The collection of intolerances the customer has.

foodDislikes
Array of strings or null

The collection of food dislikes.

foodFavorites
Array of strings or null

The collection of food favorites.

nutritionGoals
Array of strings or null (NutritionGoal)
Enum: "Unknown" "Inspiration" "SaveTimeMoney" "EatHealthy"

The collection of nutrition goals.

cuisineFavorites
Array of strings or null (Cuisine)
Enum: "Unknown" "American" "Asian" "Barbecue" "CajunAndCreole" "Chinese" "Cuban" "English" "French" "German" "Greek" "Hawaiian" "Hungarian" "Indian" "Irish" "Italian" "Japanese" "KidFriendly" "Mediterranean" "Mexican" "Moroccan" "Portuguese" "SouthernAndSoulFood" "Southwestern" "Spanish" "Swedish" "Thai" "Vietnamese" "MiddleEastern"

The collection of favorite cuisines.

cuisineDislikes
Array of strings or null (Cuisine)
Enum: "Unknown" "American" "Asian" "Barbecue" "CajunAndCreole" "Chinese" "Cuban" "English" "French" "German" "Greek" "Hawaiian" "Hungarian" "Indian" "Irish" "Italian" "Japanese" "KidFriendly" "Mediterranean" "Mexican" "Moroccan" "Portuguese" "SouthernAndSoulFood" "Southwestern" "Spanish" "Swedish" "Thai" "Vietnamese" "MiddleEastern"

The collection of disliked cuisines.

Responses

Request samples

Content type
{
  • "gender": "Unknown",
  • "adults": 0,
  • "children": 0,
  • "cookingSkill": "Unknown",
  • "cookingTimeRange": "Unknown",
  • "budgetRange": "Unknown",
  • "unit": "Unknown",
  • "calorieObjective": 0,
  • "diets": [
    ],
  • "allergies": [
    ],
  • "intolerances": [
    ],
  • "foodDislikes": [
    ],
  • "foodFavorites": [
    ],
  • "nutritionGoals": [
    ],
  • "cuisineFavorites": [
    ],
  • "cuisineDislikes": [
    ]
}

Response samples

Content type
No sample

Returns the customer of the authenticated user.

Responses

Response samples

Content type
No sample

Updates the customer of the authenticated user.

Request Body schema:

Updated values of the customer.

gender
string (Gender)
Enum: "Unknown" "Male" "Female"
adults
integer or null <int32>

The number of adults in the household.

children
integer or null <int32>

The number of children in the household.

cookingSkill
string (CookingSkill)
Enum: "Unknown" "Beginner" "Intermediate" "Advanced"
cookingTimeRange
string (CookingTimeRange)
Enum: "Unknown" "VeryQuick" "Quick" "Average" "Long" "VeryLong"
budgetRange
string (BudgetRange)
Enum: "Unknown" "Low" "Average" "High"
unit
string (Unit)
Enum: "Unknown" "Metric" "US"
calorieObjective
integer or null <int32>

The calorie objective for the customer.

diets
Array of strings or null (Diet)
Enum: "Unknown" "Atkins20" "Atkins40" "Atkins100" "AtkinsFriendly" "KetoDiet" "VeganDiet" "VegetarianDiet" "PescatarianDiet" "PaleoStrictDiet" "PaleoFriendlyDiet" "MediterraneanDiet" "DiabeticDiet" "KosherDiet" "HinduDiet" "HalalDiet"

The collection of diets followed by the customer.

allergies
Array of strings or null (Allergy)
Enum: "Unknown" "WheatFree" "DairyFree" "SoyFree" "FishFree" "ShellfishFree" "MolluskFree" "TreeNutFree" "PeanutFree" "EggFree" "AddedSugarFree" "ArtSweetenerFree" "ArtColorFree" "ArtFlavorFree" "GlutenFree" "SulfiteFree" "SesameFree" "MilkFree" "MustardFree"

The collection of allergies the customer has.

intolerances
Array of strings or null (Intolerance)
Enum: "Unknown" "WheatFree" "DairyFree" "SoyFree" "FishFree" "ShellfishFree" "MolluskFree" "TreeNutFree" "PeanutFree" "EggFree" "AddedSugarFree" "ArtSweetenerFree" "ArtColorFree" "ArtFlavorFree" "GlutenFree" "SulfiteFree" "SesameFree" "MilkFree" "MustardFree"

The collection of intolerances the customer has.

foodDislikes
Array of strings or null

The collection of food dislikes.

foodFavorites
Array of strings or null

The collection of food favorites.

nutritionGoals
Array of strings or null (NutritionGoal)
Enum: "Unknown" "Inspiration" "SaveTimeMoney" "EatHealthy"

The collection of nutrition goals.

cuisineFavorites
Array of strings or null (Cuisine)
Enum: "Unknown" "American" "Asian" "Barbecue" "CajunAndCreole" "Chinese" "Cuban" "English" "French" "German" "Greek" "Hawaiian" "Hungarian" "Indian" "Irish" "Italian" "Japanese" "KidFriendly" "Mediterranean" "Mexican" "Moroccan" "Portuguese" "SouthernAndSoulFood" "Southwestern" "Spanish" "Swedish" "Thai" "Vietnamese" "MiddleEastern"

The collection of favorite cuisines.

cuisineDislikes
Array of strings or null (Cuisine)
Enum: "Unknown" "American" "Asian" "Barbecue" "CajunAndCreole" "Chinese" "Cuban" "English" "French" "German" "Greek" "Hawaiian" "Hungarian" "Indian" "Irish" "Italian" "Japanese" "KidFriendly" "Mediterranean" "Mexican" "Moroccan" "Portuguese" "SouthernAndSoulFood" "Southwestern" "Spanish" "Swedish" "Thai" "Vietnamese" "MiddleEastern"

The collection of disliked cuisines.

Responses

Request samples

Content type
{
  • "gender": "Unknown",
  • "adults": 0,
  • "children": 0,
  • "cookingSkill": "Unknown",
  • "cookingTimeRange": "Unknown",
  • "budgetRange": "Unknown",
  • "unit": "Unknown",
  • "calorieObjective": 0,
  • "diets": [
    ],
  • "allergies": [
    ],
  • "intolerances": [
    ],
  • "foodDislikes": [
    ],
  • "foodFavorites": [
    ],
  • "nutritionGoals": [
    ],
  • "cuisineFavorites": [
    ],
  • "cuisineDislikes": [
    ]
}

Response samples

Content type
No sample

Sets the customer of the authenticated user as deleted.

Responses

Returns the customer search profile for the provided customer id.

path Parameters
id
required
string

Responses

Response samples

Content type
No sample

Updates the customer on boarding progress of the authenticated user.

Request Body schema:

Updated values of the onboarding progress of the user for a given application.

applicationName
string (ApplicationName)
Enum: "Unknown" "ConsumerApp"
Array of objects or null (OnboardingTipStateDto)

Responses

Request samples

Content type
{
  • "applicationName": "Unknown",
  • "onboardingTipStates": [
    ]
}

Response samples

Content type
No sample

Returns the customer on boarding progress of the authenticated user for a given application

path Parameters
application
required
string (ApplicationName)
Enum: "Unknown" "ConsumerApp"

Responses

Response samples

Content type
No sample

Event

Process an incoming external event

Request Body schema:

The incoming event under the CloudEvent standard

object (CloudEventsSpecVersion)
data
any or null
dataContentType
string or null
id
string or null
dataSchema
string or null <uri>
source
string or null <uri>
subject
string or null
time
string or null <date-time>
type
string or null

Responses

Request samples

Content type
{
  • "specVersion": {
    },
  • "data": null,
  • "dataContentType": "string",
  • "id": "string",
  • "dataSchema": "http://example.com",
  • "source": "http://example.com",
  • "subject": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "type": "string"
}

Response samples

Content type
No sample

Relationships

Get ratings and reviews from a given customer

path Parameters
recipeId
required
string

Details of the recipe to bookmark.

Responses

Response samples

Content type
No sample

Bookmarks recipe for a given customer

Request Body schema:

Details of the recipe to bookmark.CreateMyRecipeBookmarkCommand/>

recipeId
string or null

The unique identifier of the recipe.

Responses

Request samples

Content type
{
  • "recipeId": "string"
}

Get recipes bookmarked for a given customer

Responses

Response samples

Content type
No sample

Removes a recipe bookmark for a given customer

path Parameters
recipeId
required
string

Recipe Id

Responses

Made the recipe for current customer

Request Body schema:

Details of the recipe. CreateMyMadeRecipeCommand/>

recipeId
string or null

The unique identifier of the recipe.

Responses

Request samples

Content type
{
  • "recipeId": "string"
}

Get recipes made by current customer

Responses

Response samples

Content type
No sample

Like recipe for current customer

Request Body schema:

Details of the recipe. CreateMyLikeRecipeCommand

like
boolean

Indicates whether the recipe is liked (true) or disliked (false).

recipeId
string or null

The unique identifier of the recipe.

Responses

Request samples

Content type
{
  • "like": true,
  • "recipeId": "string"
}

Get recipes liked by current customer

Responses

Response samples

Content type
No sample

Review recipe for current customer

Request Body schema: multipart/form-data
RecipeId
string

The unique identifier of the recipe.

Comment
string

The comment for the recipe review.

RecipeTags
Array of strings

The list of tags related to the recipe.

TasteTags
Array of strings

The list of tags related to the taste of the recipe.

MakeAgainTags
Array of strings

The list of tags indicating whether the user would make the recipe again.

Image
string <binary>

The image file associated with the recipe review.

Responses

Get recipes liked by current customer

Responses

Response samples

Content type
No sample

Removes a recipe review for current customer

path Parameters
recipeId
required
string

Recipe Id

Responses

Add a recipe collection for a given customer

Request Body schema:

Details of the recipe collection to create. CreateMyRecipeCollectionCommand

name
string or null

The name of the recipe collection.

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
No sample

Update a recipe collection for a given customer

Request Body schema:

Details of the recipe collection to update. UpdateMyRecipeCollectionCommand

recipeCollectionId
string or null

The unique identifier of the recipe collection.

name
string or null

The new name of the recipe collection.

Responses

Request samples

Content type
{
  • "recipeCollectionId": "string",
  • "name": "string"
}

Get recipe collection summaries for a given customer

Responses

Response samples

Content type
No sample

Removes a recipe collection for a given customer

path Parameters
recipeCollectionId
required
string

Recipe Collection Id

Responses

Get recipe ids from a recipe collection for a given customer

path Parameters
recipeCollectionId
required
string

Recipe Collection Id

Responses

Response samples

Content type
No sample

Add a recipe to a recipe collection for a given customer

Request Body schema:

Details of the recipe collection to create.CreateMyRecipeCollectionLinkCommand

customerId
string or null

The unique identifier of the customer.

recipeCollectionId
string or null

The unique identifier of the recipe collection.

recipeId
string or null

The unique identifier of the recipe.

Responses

Request samples

Content type
{
  • "customerId": "string",
  • "recipeCollectionId": "string",
  • "recipeId": "string"
}

Removes a recipe from a recipe collection for a given customer

path Parameters
recipeCollectionId
required
string

Recipe Collection Id

recipeId
required
string

Recipe Id

Responses