Scan Harvest API

Farm

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

Get farm details

GET

http://localhost:8000/api/v1

/farms

Get farm details by farm ID or user ID

Get farm details › query Parameters

farm_idstring
Farm ID
user_idstring
User ID (or 'me' for current user)

Get farm details › Responses

Farm details retrieved successfully

farm_idstring
namestring
opening_hoursobject[]
override_activeboolean
override_expires_atstring
statusstring
timezonestring

Insert a new farm

POST

http://localhost:8000/api/v1

/farms

Insert a new farm with the provided details

Insert a new farm › Request Body

namestring
notestring
opening_hoursobject[]
timezonestring
Example: Asia/Jakarta

Insert a new farm › Responses

Farm created successfully

data
errorsobject
infoobject
request_idstring

Update farm details

PATCH

http://localhost:8000/api/v1

/farms/{farm_id}

Update farm details by farm ID

Update farm details › path Parameters

farm_idstring · required
Farm ID

Update farm details › Request Body

namestring
notestring
opening_hoursobject[]
timezonestring
Example: Asia/Jakarta

Update farm details › Responses

Farm updated successfully

data
errorsobject
infoobject
request_idstring

Get Farmer Report

GET

http://localhost:8000/api/v1

/farms/{farm_id}/reports/farmers

Retrieves a report of farmer data for a specific farm within a date range.

Get Farmer Report › path Parameters

farm_idstring · required
Farm ID

Get Farmer Report › query Parameters

start_timestring · required
Start Date (YYYY-MM-DD)
end_timestring · required
End Date (YYYY-MM-DD)

Get Farmer Report › Responses

end_datestring
fruit_yieldsobject[]
start_datestring

Export Farmer Report

GET

http://localhost:8000/api/v1

/farms/{farm_id}/reports/farmers/export

Triggers an export of farmer data for a specific farm within a date range.

Export Farmer Report › path Parameters

farm_idstring · required
Farm ID

Export Farmer Report › query Parameters

start_timestring · required
Start Date (YYYY-MM-DD)
end_timestring · required
End Date (YYYY-MM-DD)

Export Farmer Report › Responses

data
errorsobject
infoobject
request_idstring

Get Worker Report

GET

http://localhost:8000/api/v1

/farms/{farm_id}/reports/workers

Retrieves a report of worker data for a specific farm within a date range.

Get Worker Report › path Parameters

farm_idstring · required
Farm ID

Get Worker Report › query Parameters

start_timestring · required
Start Date (YYYY-MM-DD)
end_timestring · required
End Date (YYYY-MM-DD)

Get Worker Report › Responses

end_datestring
fruitsobject[]
start_datestring

Export Worker Report

GET

http://localhost:8000/api/v1

/farms/{farm_id}/reports/workers/export

Triggers an export of worker data for a specific farm within a date range.

Export Worker Report › path Parameters

farm_idstring · required
Farm ID

Export Worker Report › query Parameters

start_timestring · required
Start Date (YYYY-MM-DD)
end_timestring · required
End Date (YYYY-MM-DD)

Export Worker Report › Responses

data
errorsobject
infoobject
request_idstring

Check farm requirements

GET

http://localhost:8000/api/v1

/farms/{farm_id}/requirements

Checks if a farm meets the minimum requirements (opening hours, fruit, and block creation).

Check farm requirements › path Parameters

farm_idstring · required
Farm ID

Check farm requirements › Responses

Farm requirements fetched successfully

data
errorsobject
infoobject
request_idstring

Open or close a farm

POST

http://localhost:8000/api/v1

/farms/{farm_id}/status/{status}

Toggles the open/closed status of a farm

Open or close a farm › path Parameters

farm_idstring · required
Farm ID
statusstring · enum · required
Target status
Enum values:
open
close

Open or close a farm › Responses

Farm status updated successfully

data
errorsobject
infoobject
request_idstring

Sync data

POST

http://localhost:8000/api/v1

/farms/{farm_id}/sync

Synchronizes local changes with the server and retrieves updates.

Sync data › path Parameters

farm_idstring · required
Farm ID

Sync data › Request Body

changesobject[]
device_idstring
idempotency_keystring
last_cursorinteger

Sync data › Responses

changesobject[]
conflictsobject[]
new_cursorinteger

Auth Farm Worker

Scan Harvest API

Farm

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

Get farm details

GET

http://localhost:8000/api/v1

/farms

Get farm details by farm ID or user ID

Get farm details › query Parameters

farm_idstring
Farm ID
user_idstring
User ID (or 'me' for current user)

Get farm details › Responses

Farm details retrieved successfully

farm_idstring
namestring
opening_hoursobject[]
override_activeboolean
override_expires_atstring
statusstring
timezonestring

Insert a new farm

POST

http://localhost:8000/api/v1

/farms

Insert a new farm with the provided details

Insert a new farm › Request Body

namestring
notestring
opening_hoursobject[]
timezonestring
Example: Asia/Jakarta

Insert a new farm › Responses

Farm created successfully

data
errorsobject
infoobject
request_idstring

Update farm details

PATCH

http://localhost:8000/api/v1

/farms/{farm_id}

Update farm details by farm ID

Update farm details › path Parameters

farm_idstring · required
Farm ID

Update farm details › Request Body

namestring
notestring
opening_hoursobject[]
timezonestring
Example: Asia/Jakarta

Update farm details › Responses

Farm updated successfully

data
errorsobject
infoobject
request_idstring

Get Farmer Report

GET

http://localhost:8000/api/v1

/farms/{farm_id}/reports/farmers

Retrieves a report of farmer data for a specific farm within a date range.

Get Farmer Report › path Parameters

farm_idstring · required
Farm ID

Get Farmer Report › query Parameters

start_timestring · required
Start Date (YYYY-MM-DD)
end_timestring · required
End Date (YYYY-MM-DD)

Get Farmer Report › Responses

end_datestring
fruit_yieldsobject[]
start_datestring

Export Farmer Report

GET

http://localhost:8000/api/v1

/farms/{farm_id}/reports/farmers/export

Triggers an export of farmer data for a specific farm within a date range.

Export Farmer Report › path Parameters

farm_idstring · required
Farm ID

Export Farmer Report › query Parameters

start_timestring · required
Start Date (YYYY-MM-DD)
end_timestring · required
End Date (YYYY-MM-DD)

Export Farmer Report › Responses

data
errorsobject
infoobject
request_idstring

Get Worker Report

GET

http://localhost:8000/api/v1

/farms/{farm_id}/reports/workers

Retrieves a report of worker data for a specific farm within a date range.

Get Worker Report › path Parameters

farm_idstring · required
Farm ID

Get Worker Report › query Parameters

start_timestring · required
Start Date (YYYY-MM-DD)
end_timestring · required
End Date (YYYY-MM-DD)

Get Worker Report › Responses

end_datestring
fruitsobject[]
start_datestring

Export Worker Report

GET

http://localhost:8000/api/v1

/farms/{farm_id}/reports/workers/export

Triggers an export of worker data for a specific farm within a date range.

Export Worker Report › path Parameters

farm_idstring · required
Farm ID

Export Worker Report › query Parameters

start_timestring · required
Start Date (YYYY-MM-DD)
end_timestring · required
End Date (YYYY-MM-DD)

Export Worker Report › Responses

data
errorsobject
infoobject
request_idstring

Check farm requirements

GET

http://localhost:8000/api/v1

/farms/{farm_id}/requirements

Checks if a farm meets the minimum requirements (opening hours, fruit, and block creation).

Check farm requirements › path Parameters

farm_idstring · required
Farm ID

Check farm requirements › Responses

Farm requirements fetched successfully

data
errorsobject
infoobject
request_idstring

Open or close a farm

POST

http://localhost:8000/api/v1

/farms/{farm_id}/status/{status}

Toggles the open/closed status of a farm

Open or close a farm › path Parameters

farm_idstring · required
Farm ID
statusstring · enum · required
Target status
Enum values:
open
close

Open or close a farm › Responses

Farm status updated successfully

data
errorsobject
infoobject
request_idstring

Sync data

POST

http://localhost:8000/api/v1

/farms/{farm_id}/sync

Synchronizes local changes with the server and retrieves updates.

Sync data › path Parameters

farm_idstring · required
Farm ID

Sync data › Request Body

changesobject[]
device_idstring
idempotency_keystring
last_cursorinteger

Sync data › Responses

changesobject[]
conflictsobject[]
new_cursorinteger

Auth Farm Worker