Edit Ingredient

patch

https://api.apicbase.com/api/v2/products/ingredients/{ingredient_id}/

Edits an existing ingredient.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

ingredient_id

string

required

An ingredient's ID

Body Params

name

string

short_name

string

approved

boolean

allergen_verified

boolean

archived

boolean

If true, the ingredient is archived; if false, it is unarchived. If omitted, the current archive state is preserved.

custom_fields

json

preferred_uoms

array of strings

preferred_uoms

conversion_ratio

float

internal_uid

string

Internal ID in the user interface. Uniqueness is enforced in this field.

external_uid

string

External ID in the user interface.

composition

string

description

string

brand

string

category

string

subcategory

string

accounting_category

string

storage_instructions

string

shelf_life

string

allergens

object

additional_info

object

nutrition_info

object

images

array of strings

An array of image IDs.

images

main_image

string

An image's ID.

carbon_footprint

object

stock_variants

array of strings

An array of ingredient IDs.

stock_variants

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200