Scan Harvest API

Fruit

Endpoint:http://localhost:8000/api/v1

Find fruits by farm ID

GET

http://localhost:8000/api/v1

/farms/{farm_id}/fruits

Retrieve a list of fruits associated with a given farm ID

Find fruits by farm ID › path Parameters

farm_idstring · required
Farm ID

Find fruits by farm ID › Responses

List of fruits

fruitobject
notesobject[]
pricesobject[]

Insert a new fruit

POST

http://localhost:8000/api/v1

/farms/{farm_id}/fruits

Insert a new fruit into the database

Insert a new fruit › path Parameters

farm_idstring · required
Farm ID

Insert a new fruit › Request Body

is_activeboolean
namestring
notestring
pricenumber
unitstring
varietystring

Insert a new fruit › Responses

Fruit inserted successfully

data
errorsobject
infoobject
request_idstring

Delete a fruit

DELETE

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/{fruit_id}

Delete a fruit identified by its ID

Delete a fruit › path Parameters

farm_idstring · required
Farm ID
fruit_idstring · required
Fruit ID

Delete a fruit › Responses

Fruit deleted successfully

data
errorsobject
infoobject
request_idstring

Update an existing fruit

PATCH

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/{fruit_id}

Update details of an existing fruit identified by its ID

Update an existing fruit › path Parameters

farm_idstring · required
Farm ID
fruit_idstring · required
Fruit ID

Update an existing fruit › Request Body

is_activeboolean
namestring
notestring
pricenumber
unitstring
varietystring

Update an existing fruit › Responses

Fruit updated successfully

data
errorsobject
infoobject
request_idstring

Merge fruit data

POST

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/merge

Merge fruit data based on the provided request

Merge fruit data › path Parameters

farm_idstring · required
Farm ID

Merge fruit data › Request Body

source_fruit_idsstring[]
target_fruit_idstring

Merge fruit data › Responses

Fruit merged successfully

data
errorsobject
infoobject
request_idstring

List all fruit names

GET

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/names

Retrieve a list of all fruit names for a specific farm

List all fruit names › path Parameters

farm_idstring · required
Farm ID

List all fruit names › Responses

List of fruit names

fruit_idstring
namestring
unitstring
varietystring

List all unique fruit units

GET

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/units

Retrieve a list of all unique measurement units used for fruits in a specific farm

List all unique fruit units › path Parameters

farm_idstring · required
Farm ID

List all unique fruit units › Responses

List of fruit units

unitsstring[]

Merge fruit units

POST

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/units/merge

Merge units from a source fruit into a target fruit

Merge fruit units › path Parameters

farm_idstring · required
Farm ID

Merge fruit units › Request Body

source_fruit_idstring
target_fruit_idstring

Merge fruit units › Responses

Fruit units merged successfully

data
errorsobject
infoobject
request_idstring

Dashboard Sessions

Scan Harvest API

Fruit

Endpoint:http://localhost:8000/api/v1

Find fruits by farm ID

GET

http://localhost:8000/api/v1

/farms/{farm_id}/fruits

Retrieve a list of fruits associated with a given farm ID

Find fruits by farm ID › path Parameters

farm_idstring · required
Farm ID

Find fruits by farm ID › Responses

List of fruits

fruitobject
notesobject[]
pricesobject[]

Insert a new fruit

POST

http://localhost:8000/api/v1

/farms/{farm_id}/fruits

Insert a new fruit into the database

Insert a new fruit › path Parameters

farm_idstring · required
Farm ID

Insert a new fruit › Request Body

is_activeboolean
namestring
notestring
pricenumber
unitstring
varietystring

Insert a new fruit › Responses

Fruit inserted successfully

data
errorsobject
infoobject
request_idstring

Delete a fruit

DELETE

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/{fruit_id}

Delete a fruit identified by its ID

Delete a fruit › path Parameters

farm_idstring · required
Farm ID
fruit_idstring · required
Fruit ID

Delete a fruit › Responses

Fruit deleted successfully

data
errorsobject
infoobject
request_idstring

Update an existing fruit

PATCH

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/{fruit_id}

Update details of an existing fruit identified by its ID

Update an existing fruit › path Parameters

farm_idstring · required
Farm ID
fruit_idstring · required
Fruit ID

Update an existing fruit › Request Body

is_activeboolean
namestring
notestring
pricenumber
unitstring
varietystring

Update an existing fruit › Responses

Fruit updated successfully

data
errorsobject
infoobject
request_idstring

Merge fruit data

POST

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/merge

Merge fruit data based on the provided request

Merge fruit data › path Parameters

farm_idstring · required
Farm ID

Merge fruit data › Request Body

source_fruit_idsstring[]
target_fruit_idstring

Merge fruit data › Responses

Fruit merged successfully

data
errorsobject
infoobject
request_idstring

List all fruit names

GET

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/names

Retrieve a list of all fruit names for a specific farm

List all fruit names › path Parameters

farm_idstring · required
Farm ID

List all fruit names › Responses

List of fruit names

fruit_idstring
namestring
unitstring
varietystring

List all unique fruit units

GET

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/units

Retrieve a list of all unique measurement units used for fruits in a specific farm

List all unique fruit units › path Parameters

farm_idstring · required
Farm ID

List all unique fruit units › Responses

List of fruit units

unitsstring[]

Merge fruit units

POST

http://localhost:8000/api/v1

/farms/{farm_id}/fruits/units/merge

Merge units from a source fruit into a target fruit

Merge fruit units › path Parameters

farm_idstring · required
Farm ID

Merge fruit units › Request Body

source_fruit_idstring
target_fruit_idstring

Merge fruit units › Responses

Fruit units merged successfully

data
errorsobject
infoobject
request_idstring

Dashboard Sessions