Create an ingredient

curl --request POST \
  --url https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Carrot",
  "in_stock_qty": 3,
  "price": 999
}
'

import requests

url = "https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients"

payload = {
    "name": "Carrot",
    "in_stock_qty": 3,
    "price": 999
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Carrot', in_stock_qty: 3, price: 999})
};

fetch('https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Carrot',
    'in_stock_qty' => 3,
    'price' => 999
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients"

	payload := strings.NewReader("{\n  \"name\": \"Carrot\",\n  \"in_stock_qty\": 3,\n  \"price\": 999\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Carrot\",\n  \"in_stock_qty\": 3,\n  \"price\": 999\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Carrot\",\n  \"in_stock_qty\": 3,\n  \"price\": 999\n}"

response = http.request(request)
puts response.read_body

{
  "id": "674d0bf5c28b69001f8e03a1",
  "created_at": "2024-04-22T10:00:00Z",
  "updated_at": "2024-04-22T10:00:00Z",
  "name": "Carrot",
  "in_stock_qty": 3,
  "price": 999
}

{
  "title": "Human-readable error title.",
  "detail": "Human-readable error details."
}

{
  "title": "Human-readable error title.",
  "detail": "Human-readable error details."
}

POST

ingredients

Create an ingredient

curl --request POST \
  --url https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Carrot",
  "in_stock_qty": 3,
  "price": 999
}
'

import requests

url = "https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients"

payload = {
    "name": "Carrot",
    "in_stock_qty": 3,
    "price": 999
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Carrot', in_stock_qty: 3, price: 999})
};

fetch('https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Carrot',
    'in_stock_qty' => 3,
    'price' => 999
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients"

	payload := strings.NewReader("{\n  \"name\": \"Carrot\",\n  \"in_stock_qty\": 3,\n  \"price\": 999\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Carrot\",\n  \"in_stock_qty\": 3,\n  \"price\": 999\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Carrot\",\n  \"in_stock_qty\": 3,\n  \"price\": 999\n}"

response = http.request(request)
puts response.read_body

{
  "id": "674d0bf5c28b69001f8e03a1",
  "created_at": "2024-04-22T10:00:00Z",
  "updated_at": "2024-04-22T10:00:00Z",
  "name": "Carrot",
  "in_stock_qty": 3,
  "price": 999
}

{
  "title": "Human-readable error title.",
  "detail": "Human-readable error details."
}

{
  "title": "Human-readable error title.",
  "detail": "Human-readable error details."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request body to create an ingredient to be included with dishes requires the following properties: name, price, and in_stock_qty.

name

string

required

The ingredient name to display in the client app.

Example:

"Carrot"

in_stock_qty

integer

required

The quantity of the ingredient currently in stock. This field is used to track the ingredient inventory. If the ingredient is essential and has a value of 0, the associated dish cannot be ordered via the client app.

Example:

3

price

number<float>

required

The price used by the client app to calculate order cost.

Example:

999

Response

Ingredient created successfully

string

read-only

A unique alpha-numeric string generated by the system when creating a resource (e.g., dishes, ingredients, etc). Ids are required for retrieving the properties of a specific resource.

Example:

"674d0bf5c28b69001f8e03a1"

created_at

string<date-time>

read-only

The date and time the resource was created. Timestamp uses ISO 8601 format, Ex: 2025-04-05T14:55:03.824Z

Example:

"2024-04-22T10:00:00Z"

updated_at

string<date-time>

read-only

The date and time the resource was last updated.

Timestamp uses ISO 8601 format, Ex: 2025-04-05T14:55:03.824Z

Example:

"2024-04-22T10:00:00Z"

name

string

The name of the ingredient that will appear in the client app.

Example:

"Carrot"

in_stock_qty

integer

Example:

3

price

number<float>

The price used by the client app to calculate order cost.

Example:

999

API Documentation

Endpoints

Create an ingredient

Authorizations

Body

Response