POST
/
supply-chains
/
farmers

Authorizations

Authorization
string
header
required

Body

application/json
first_name
string
required

First name of the farmer. This is part of the farmer's personal details.

Required string length: 1 - 100
buyer
string

Identifier of the buyer associated with the farmer. This indicates any buyer or customer linked to the farmer, if applicable.

city
string | null

Name of the city where the farmer resides. This is part of the farmer's address details.

Maximum length: 500

Consent status of the farmer for data usage. This indicates whether the farmer has given consent for their data to be used.

Available options:
GRANTED,
NOT_GRANTED,
UNKNOWN
country
string | null

Name of the country where the farmer resides. This is part of the farmer's address details.

Maximum length: 500
created_on
string

Date and time when the farmer information was created. This field indicates when the farmer record was initially added to the system.

creator
string

Identifier of the user who created the farmer entry. This indicates the user responsible for adding the farmer information to the system.

date_of_birth
string | null

Date of birth of the farmer. This is part of the farmer's personal details.

description
string | null

Description or additional information about the farmer. This field allows for notes or comments to be added regarding the farmer.

Maximum length: 500
email
string | null

Email address of the farmer. This is used for electronic communication with the farmer.

Maximum length: 100
entity_card
object

Information related to the Connect card of the farmer.

gender
string | null

Gender of the farmer. This is part of the farmer's personal details.

Maximum length: 50
house_name
string | null

Name of the house or building where the farmer resides. This could be useful for address clarification.

Maximum length: 100
id
string

Unique identifier for the farmer. This identifier is used to distinguish one farmer from another in the system.

identification_no
string | null

Identification number of the farmer. This could be a national identification number or any other form of identification.

Maximum length: 100
last_name
string | null

Last name of the farmer. This is part of the farmer's personal details.

Maximum length: 100
latitude
number

Latitude coordinate of the farmer's location. This is used for geolocation purposes.

longitude
number

Longitude coordinate of the farmer's location. This is used for geolocation purposes.

number
string | null

Additional number for reference. It will be a auto generated value field.

Maximum length: 10
phone
string | null

Phone number of the farmer. This is typically used for contacting the farmer if necessary.

province
string | null

Name of the province where the farmer resides. This is part of the farmer's address details.

Maximum length: 500
reference_number
string | null

Reference number associated with the farmer. This could be a reference to another system or database.

Maximum length: 100
street
string | null

Name of the street where the farmer resides. This is part of the farmer's address details.

Maximum length: 500
sub_province
string | null

Name of the sub-province where the farmer resides. This is part of the farmer's address details.

Maximum length: 500
submission
object

Submission details related to the farmer. This could include any extra fields metioned in form associated with the company.

updater
string

Identifier of the user who last updated the farmer entry. This indicates the user responsible for the latest modifications to the farmer information.

zipcode
string | null

Postal code or ZIP code of the area where the farmer resides. This is part of the farmer's address details.

Maximum length: 50

Response

201 - application/json
first_name
string
required

First name of the farmer. This is part of the farmer's personal details.

Required string length: 1 - 100
buyer
string

Identifier of the buyer associated with the farmer. This indicates any buyer or customer linked to the farmer, if applicable.

city
string | null

Name of the city where the farmer resides. This is part of the farmer's address details.

Maximum length: 500

Consent status of the farmer for data usage. This indicates whether the farmer has given consent for their data to be used.

Available options:
GRANTED,
NOT_GRANTED,
UNKNOWN
country
string | null

Name of the country where the farmer resides. This is part of the farmer's address details.

Maximum length: 500
created_on
string

Date and time when the farmer information was created. This field indicates when the farmer record was initially added to the system.

creator
string

Identifier of the user who created the farmer entry. This indicates the user responsible for adding the farmer information to the system.

date_of_birth
string | null

Date of birth of the farmer. This is part of the farmer's personal details.

description
string | null

Description or additional information about the farmer. This field allows for notes or comments to be added regarding the farmer.

Maximum length: 500
email
string | null

Email address of the farmer. This is used for electronic communication with the farmer.

Maximum length: 100
entity_card
object

Information related to the Connect card of the farmer.

gender
string | null

Gender of the farmer. This is part of the farmer's personal details.

Maximum length: 50
house_name
string | null

Name of the house or building where the farmer resides. This could be useful for address clarification.

Maximum length: 100
id
string

Unique identifier for the farmer. This identifier is used to distinguish one farmer from another in the system.

identification_no
string | null

Identification number of the farmer. This could be a national identification number or any other form of identification.

Maximum length: 100
image
string | null

URL to the photo of the farmer. This could be a link to a profile picture or any relevant image associated with the farmer.

last_name
string | null

Last name of the farmer. This is part of the farmer's personal details.

Maximum length: 100
latitude
number

Latitude coordinate of the farmer's location. This is used for geolocation purposes.

longitude
number

Longitude coordinate of the farmer's location. This is used for geolocation purposes.

number
string | null

Additional number for reference. It will be a auto generated value field.

Maximum length: 10
phone
string | null

Phone number of the farmer. This is typically used for contacting the farmer if necessary.

province
string | null

Name of the province where the farmer resides. This is part of the farmer's address details.

Maximum length: 500
reference_number
string | null

Reference number associated with the farmer. This could be a reference to another system or database.

Maximum length: 100
street
string | null

Name of the street where the farmer resides. This is part of the farmer's address details.

Maximum length: 500
sub_province
string | null

Name of the sub-province where the farmer resides. This is part of the farmer's address details.

Maximum length: 500
submission
object

Submission details related to the farmer. This could include any extra fields metioned in form associated with the company.

updated_on
string

Date and time when the farmer information was last updated. This field is automatically generated and cannot be modified directly.

updater
string

Identifier of the user who last updated the farmer entry. This indicates the user responsible for the latest modifications to the farmer information.

zipcode
string | null

Postal code or ZIP code of the area where the farmer resides. This is part of the farmer's address details.

Maximum length: 50