Skip to main content
POST
/
supply-chains
/
farmers
/
cURL
curl --request POST \
  --url http://localhost:3000/connect/v1/supply-chains/farmers/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "entity_card": {
    "id": "<string>",
    "card": {
      "id": "<string>",
      "card_id": "<string>",
      "display_id": "<string>",
      "creator": "<string>",
      "updater": "<string>"
    },
    "creator": "<string>",
    "updater": "<string>",
    "entity": "<string>"
  },
  "submission": {
    "id": "<string>",
    "form_details": {
      "id": "<string>",
      "fields": [
        {
          "id": "<string>",
          "label": "<string>",
          "label_en_us": "<string>",
          "label_en_uk": "<string>",
          "label_fr": "<string>",
          "label_nl": "<string>",
          "label_ind": "<string>",
          "type": "TEXT",
          "key": "<string>",
          "required": true,
          "default_value": "<string>",
          "options": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "field_config": [
        {
          "id": "<string>",
          "label": "<string>",
          "key": "<string>",
          "visibility": true,
          "required": true,
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "form_type": "TRANSACTION",
      "creator": "<string>",
      "updater": "<string>",
      "owner": "<string>"
    },
    "values": [
      {
        "id": "<string>",
        "field_details": {
          "id": "<string>",
          "label": "<string>",
          "label_en_us": "<string>",
          "label_en_uk": "<string>",
          "label_fr": "<string>",
          "label_nl": "<string>",
          "label_ind": "<string>",
          "type": "TEXT",
          "key": "<string>",
          "required": true,
          "default_value": "<string>",
          "options": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        },
        "field": "<string>",
        "value": "<string>",
        "creator": "<string>",
        "updater": "<string>"
      }
    ],
    "creator": "<string>",
    "updater": "<string>",
    "form": "<string>",
    "product": "<string>"
  },
  "phone": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "house_name": "<string>",
  "street": "<string>",
  "city": "<string>",
  "sub_province": "<string>",
  "province": "<string>",
  "latitude": 123,
  "longitude": 123,
  "zipcode": "<string>",
  "country": "<string>",
  "number": "<string>",
  "email": "jsmith@example.com",
  "identification_no": "<string>",
  "reference_number": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "gender": "<string>",
  "consent_status": "GRANTED",
  "creator": "<string>",
  "updater": "<string>",
  "buyer": "<string>"
}'
{
  "id": "<string>",
  "entity_card": {
    "id": "<string>",
    "card": {
      "id": "<string>",
      "card_id": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "display_id": "<string>",
      "creator": "<string>",
      "updater": "<string>"
    },
    "updated_on": "2023-11-07T05:31:56Z",
    "created_on": "2023-11-07T05:31:56Z",
    "is_active": true,
    "creator": "<string>",
    "updater": "<string>",
    "entity": "<string>"
  },
  "submission": {
    "id": "<string>",
    "form_details": {
      "id": "<string>",
      "products": [
        {
          "id": "<string>",
          "premiums": "<string>",
          "is_active": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "description": "<string>",
          "image": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "fields": [
        {
          "id": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "label": "<string>",
          "label_en_us": "<string>",
          "label_en_uk": "<string>",
          "label_fr": "<string>",
          "label_nl": "<string>",
          "label_ind": "<string>",
          "type": "TEXT",
          "key": "<string>",
          "required": true,
          "default_value": "<string>",
          "options": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "field_config": [
        {
          "id": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "label": "<string>",
          "key": "<string>",
          "visibility": true,
          "required": true,
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "form_type": "TRANSACTION",
      "creator": "<string>",
      "updater": "<string>",
      "owner": "<string>"
    },
    "values": [
      {
        "id": "<string>",
        "field_details": {
          "id": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "label": "<string>",
          "label_en_us": "<string>",
          "label_en_uk": "<string>",
          "label_fr": "<string>",
          "label_nl": "<string>",
          "label_ind": "<string>",
          "type": "TEXT",
          "key": "<string>",
          "required": true,
          "default_value": "<string>",
          "options": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        },
        "field": "<string>",
        "updated_on": "2023-11-07T05:31:56Z",
        "created_on": "2023-11-07T05:31:56Z",
        "value": "<string>",
        "creator": "<string>",
        "updater": "<string>"
      }
    ],
    "updated_on": "2023-11-07T05:31:56Z",
    "created_on": "2023-11-07T05:31:56Z",
    "creator": "<string>",
    "updater": "<string>",
    "form": "<string>",
    "product": "<string>"
  },
  "phone": "<string>",
  "updated_on": "2023-11-07T05:31:56Z",
  "created_on": "2023-11-07T05:31:56Z",
  "image": "<string>",
  "description": "<string>",
  "house_name": "<string>",
  "street": "<string>",
  "city": "<string>",
  "sub_province": "<string>",
  "province": "<string>",
  "latitude": 123,
  "longitude": 123,
  "zipcode": "<string>",
  "country": "<string>",
  "number": "<string>",
  "email": "jsmith@example.com",
  "identification_no": "<string>",
  "reference_number": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "gender": "<string>",
  "consent_status": "GRANTED",
  "creator": "<string>",
  "updater": "<string>",
  "buyer": "<string>"
}

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
​
id
string

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

​
entity_card
object

Information related to the Connect card of the farmer.

​
submission
object

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

​
phone
string | null

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

​
created_on
string<date-time>

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

​
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
​
house_name
string | null

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

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
​
city
string | null

Name of the city 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
​
province
string | null

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

Maximum length: 500
​
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.

​
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
​
country
string | null

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

Maximum length: 500
​
number
string | null

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

Maximum length: 10
​
email
string<email> | null

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

Maximum length: 100
​
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
​
reference_number
string | null

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

Maximum length: 100
​
last_name
string | null

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

Maximum length: 100
​
date_of_birth
string<date> | null

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

​
gender
string | null

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

Maximum length: 50
​
consent_status
enum<string>

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
​
creator
string

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

​
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.

​
buyer
string

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

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
​
id
string

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

​
entity_card
object

Information related to the Connect card of the farmer.

​
submission
object

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

​
phone
string | null

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

​
updated_on
string<date-time>

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

​
created_on
string<date-time>

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

​
image
string<uri> | 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.

​
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
​
house_name
string | null

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

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
​
city
string | null

Name of the city 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
​
province
string | null

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

Maximum length: 500
​
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.

​
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
​
country
string | null

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

Maximum length: 500
​
number
string | null

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

Maximum length: 10
​
email
string<email> | null

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

Maximum length: 100
​
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
​
reference_number
string | null

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

Maximum length: 100
​
last_name
string | null

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

Maximum length: 100
​
date_of_birth
string<date> | null

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

​
gender
string | null

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

Maximum length: 50
​
consent_status
enum<string>

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
​
creator
string

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

​
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.

​
buyer
string

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