Responses

Responses are returned, using a standardized JSON response.

Success

On success, the API returns a standardized JSON response with a status of 0, as seen below:

{
    "status":"0",
    "field":"",
    "description":"success"
}

Error Responses

On error, the API returns a standardized JSON response. Please note that "field" is not always returned, but when it is, it's referring to the field that caused the error to occur.

{
    "status":"45",
    "field":"cost",
    "description":"Invalid number"
}
Error Response Details
Status Description
1 missing required Authentication-Info parameter
2 authentication failure
3 invalid request
4 connection is not secure, please use HTTPS
5 invalid URL
6 ownership check failed or record does not exist
7 no records found
8 missing required field
9 account status is closed
10 Authentication-Info is incorrect
11 JSON is invalid or missing fields
12 Customer cannot be deleted (Active Subscription)
13 Invalid value for type
14 Invalid boolean value (should be 1 or 0)
15 missing JSON payload
16 Invalid value for organic
17 Invalid date format (should be YYYY-MM-DD)
18 Record is already marked as disposed of
19 Cannot approve record that is not marked as disposed of
20 Record is already marked as approved
21 Sowing record cannot be deleted (Approved Disposal)
22 Number of trays cannot be zero or less than zero
23 Value must be a whole number
24 Invalid value for status
25 Invalid value for fulfillment
26 Product Price ID does not match Product ID
27 Interval ID is invalid
28 Invalid value for cut-short
29 Sorting failed
30 Database call or connection failed
31 Seed cannot be deleted (Sowing records exist)
32 Growing Medium cannot be deleted (Sowing records exist)
33 Product Category cannot be deleted (Products exist)
34 Seed Supplier cannot be deleted (Seed records exist)
35 Product Price cannot be deleted (Active Recurring Orders exist)
36 Product Price cannot be deleted (Future One-Time Orders exist)
37 Value must be an integer (positive or negative, no decimal)
38 Number must be a positive number
39 Number cannot be a decimal
40 Family ID is invalid
41 Number must be greater than zero
42 Invalid value for sort
43 Date range is invalid (start date comes after end date)
44 Date range is invalid (plant date comes after harvest date)
45 Invalid number
46 Customer cannot be deleted (Future One-Time Orders exist)
47 Team Member cannot be deleted (records exist)