This page was automatically generated from tracezilla’s Swagger API documentation 2026-07-17
GET /ingredients/{ingredientId}
Get Ingredients
Description
Returns Ingredients
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| ingredientId | required | Target Ingredient. |
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| include | optional | The resources that can be included in this request, delimited by a comma: translations |
Responses
200
successful operation
Response content JSON schema
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
"properties": {
"required": [
"default_name"
],
"properties": {
"id": {
"description": "Id of the Ingredient record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"default_name": {
"description": "The default text if no translation exists",
"type": "string",
"format": "string",
"example": "Super customer discount"
},
"is_allergen": {
"description": "If this ingredient is an allergen",
"type": "boolean",
"format": "bool",
"example": true
},
"translations": {
"description": "Translations of the Ingredient entity. \nTranslations should be an object where the property name is the ISO 639-1 Code 2 letter language code and the value is the translation\nNotice that these will only be included if *translations* are included in the include parameter",
"properties": {
"da": {
"type": "string",
"format": "string",
"example": "Rabat"
},
"de": {
"type": "string",
"format": "string",
"example": "Rabatt"
}
},
"type": "object"
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"updated_at": {
"description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
},
"type": "object"
}
406
not acceptable
500
internal server error
PUT /ingredients/{ingredientId}
Update existing Ingredient
Description
Update the specified resource in storage.
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| ingredientId | required | Target Ingredient. |
Request body
Description
Target Ingredient.
Required
This parameter is required.
Request body JSON schema
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
"required": [
"default_name"
],
"properties": {
"id": {
"description": "Id of the Ingredient record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"default_name": {
"description": "The default text if no translation exists",
"type": "string",
"format": "string",
"example": "Super customer discount"
},
"is_allergen": {
"description": "If this ingredient is an allergen",
"type": "boolean",
"format": "bool",
"example": true
},
"translations": {
"description": "Translations of the Ingredient entity. \nTranslations should be an object where the property name is the ISO 639-1 Code 2 letter language code and the value is the translation\nNotice that these will only be included if *translations* are included in the include parameter",
"properties": {
"da": {
"type": "string",
"format": "string",
"example": "Rabat"
},
"de": {
"type": "string",
"format": "string",
"example": "Rabatt"
}
},
"type": "object"
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"updated_at": {
"description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
}
Responses
200
successful operation
Response content JSON schema
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
"properties": {
"required": [
"default_name"
],
"properties": {
"id": {
"description": "Id of the Ingredient record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"default_name": {
"description": "The default text if no translation exists",
"type": "string",
"format": "string",
"example": "Super customer discount"
},
"is_allergen": {
"description": "If this ingredient is an allergen",
"type": "boolean",
"format": "bool",
"example": true
},
"translations": {
"description": "Translations of the Ingredient entity. \nTranslations should be an object where the property name is the ISO 639-1 Code 2 letter language code and the value is the translation\nNotice that these will only be included if *translations* are included in the include parameter",
"properties": {
"da": {
"type": "string",
"format": "string",
"example": "Rabat"
},
"de": {
"type": "string",
"format": "string",
"example": "Rabatt"
}
},
"type": "object"
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"updated_at": {
"description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
},
"type": "object"
}
403
Unauthorized request
406
not acceptable
500
Internal server error
DELETE /ingredients/{ingredientId}
Delete document dtring
Description
Remove the specified resource from storage.
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| ingredientId | required | Target Ingredient. |
Responses
204
The service was deleted
403
Unauthorized request
406
not acceptable
500
Internal server error