Merran documentation API & integrations

What a recipe goes with

GET

/api/recipes/{recipe}/pairings

const url = 'http://localhost:3000/api/recipes/lemon-chicken/pairings';
const options = {
  method: 'GET',
  headers: {cookie: 'merran.session_token=<merran.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/recipes/lemon-chicken/pairings \
  --cookie merran.session_token=<merran.session_token>

Recipes it pairs with, picked or by a whole tag, every recipe that adds up to, and the recipes it’s offered with. Recipes in Recently deleted are left out. With an API key, it needs the recipes: read permission.

Authorizations

session
apiKey

Parameters

Path Parameters

recipe

required

The recipe’s id, or its slug.

string

Example

lemon-chicken

The recipe’s id, or its slug.

Responses

200

What it goes with.

application/json

object

pairings

required

What it goes with, as set.

Array

One of:

object
object

object

required

string

kind

required

string

Allowed values: recipe

recipe

required

object

required

string

slug

required

string

name

required

string

photo

required

Its card-sized photo, or null.

string | null

servings

required

number | null

totalMinutes

required

number | null

options

required

Every recipe that adds up to: picked ones first, then tagged ones by name.

Array<object>

object

required

string

slug

required

string

name

required

string

photo

required

Its card-sized photo, or null.

string | null

servings

required

number | null

totalMinutes

required

number | null

pairsWith

required

Recipes it’s offered with: the other way round.

Array<object>

object

required

string

slug

required

string

name

required

string

photo

required

Its card-sized photo, or null.

string | null

servings

required

number | null

totalMinutes

required

number | null

Example

{
  "pairings": [
    {
      "id": "0199e8b0-5a10-7a01-8b00-00000000000e",
      "kind": "recipe",
      "recipe": {
        "id": "0199e8b0-5a10-7a01-8b00-000000000007",
        "slug": "garlic-rice",
        "name": "Garlic Rice",
        "photo": null,
        "servings": 4,
        "totalMinutes": 25
      }
    },
    {
      "id": "0199e8b0-5a10-7a01-8b00-00000000000f",
      "kind": "tag",
      "tag": "salad"
    }
  ],
  "options": [
    {
      "id": "0199e8b0-5a10-7a01-8b00-000000000007",
      "slug": "garlic-rice",
      "name": "Garlic Rice",
      "photo": null,
      "servings": 4,
      "totalMinutes": 25
    }
  ],
  "pairsWith": []
}

401

Not signed in.

application/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

403

Not allowed.

application/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

404

No such recipe.

application/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}